/payments

get

https://api-sandbox.getdefacto.com/payments

Get payments related to loans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

string

Defaults to null

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

deposit_id

array of strings or null

Filter payments linked to these deposit IDs.

deposit_id

from_account_id

string

Defaults to null

Filter by source account ID.

from_date

date-time

Defaults to null

Return payments created on or after this date.

array of uuids

Filter by one or more payment UUIDs.

include_bills

boolean

Defaults to true

Include billing payments (default: true).

include_loans

boolean

Defaults to true

Include loan disbursement payments (default: true).

include_payment_intents

boolean

Defaults to true

Include payment intent payments (default: true).

is_reconciled

boolean

Defaults to null

Filter by reconciliation status.

loan_id

array of strings or null

Filter payments linked to these loan IDs.

loan_id

page_size

integer

Defaults to 100

Maximum number of items to return per page.

paid_after

date-time

Defaults to null

Return payments where paid_at is after this date.

paid_before

date-time

Defaults to null

Return payments where paid_at is before this date.

payment_intent_id

array of strings or null

Filter payments linked to these payment intent IDs.

payment_intent_id

payment_method

array of strings

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

payment_method

payment_type

array of strings

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

payment_type

references

array of strings

Filter by payment references.

references

sort_by

string

enum

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

Allowed:

status

array of strings

Filter by payment status.

status

to_account_id

string

Defaults to null

Filter by destination account ID.

to_date

date-time

Defaults to null

Return payments created on or before this date.

updated_after

date-time

Defaults to null

Return payments updated after this date.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200