0a9c1f8784f2
Get payments related to loans
Query parameters
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.
Pagination cursor from the previous response's next_page field. Omit to get the first page.
Filter payments linked to these deposit IDs.
Filter by source account ID.
Return payments created on or after this date.
Filter by one or more payment UUIDs.
Include billing payments (default: true).
Include loan disbursement payments (default: true).
Include payment intent payments (default: true).
Filter by reconciliation status.
Filter payments linked to these loan IDs.
Maximum number of items to return per page.
Return payments where paid_at is after this date.
Return payments where paid_at is before this date.
Filter payments linked to these payment intent IDs.
Filter by payment method (e.g. DIRECT_DEBIT, SCT).
Filter by payment type (e.g. LOAN_PAYMENT, REPAYMENT).
Filter by payment references.
Sort field and direction (format: column:ASC or column:DESC).
Filter by payment status.
Filter by destination account ID.
Return payments created on or before this date.
Return payments updated after this date.
Response
OK