List Payments

List all payments with pagination, filtering, and sorting options.

Payments can be filtered by invoice IDs, statuses, date ranges, or search terms.

invoice_idstring[] nullable

Filter by invoice IDs. Default is None.

statusesPaymentStatusEnum[] nullable

Filter by payment statuses. Default is None.

search_termstring nullable

Search term to filter payments. Default is None.

from_datestring date-time nullable

Filter payments from this date. Default is None.

to_datestring date-time nullable

Filter payments up to this date. Default is None.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response