latestSwagger 2.02026-08-2181213270.0 KB

0a9c1f8784f2

Payment

Get payments related to loans

get/payments

Query parameters

business_idstring

Filter to payments whose source or destination account is dedicated to this business (account_detail.dedicated_to_business_id). Scopes a search to one business without a reference/amount full-table scan.

cursorstring

Pagination cursor from the previous response's next_page field. Omit to get the first page.

deposit_idstring[]

Filter payments linked to these deposit IDs.

from_account_idstring

Filter by source account ID.

from_datestring date-time

Return payments created on or after this date.

idstring[]

Filter by one or more payment UUIDs.

include_billsboolean

Include billing payments (default: true).

include_loansboolean

Include loan disbursement payments (default: true).

include_payment_intentsboolean

Include payment intent payments (default: true).

is_reconciledboolean

Filter by reconciliation status.

loan_idstring[]

Filter payments linked to these loan IDs.

page_sizeinteger

Maximum number of items to return per page.

paid_afterstring date-time

Return payments where paid_at is after this date.

paid_beforestring date-time

Return payments where paid_at is before this date.

payment_intent_idstring[]

Filter payments linked to these payment intent IDs.

payment_methodstring[]

Filter by payment method (e.g. DIRECT_DEBIT, SCT).

payment_typestring[]

Filter by payment type (e.g. LOAN_PAYMENT, REPAYMENT).

referencesstring[]

Filter by payment references.

sort_by'amount:asc' | 'amount:desc' | 'payment_method:asc' | 'payment_method:desc' | 'scheduled_at:asc' | 'scheduled_at:desc'

Sort field and direction (format: column:ASC or column:DESC).

statusstring[]

Filter by payment status.

to_account_idstring

Filter by destination account ID.

to_datestring date-time

Return payments created on or before this date.

updated_afterstring date-time

Return payments updated after this date.

Response

OK