List payments

Lists the payments (charges) made to your business, newest first.

Narrow the list with:

  • start_date / end_date: only payments created in that date range (inclusive, whole days in Gulf Standard Time, UTC+4).
  • link_identifier: only payments made on one payment link.
  • order_by[field] / order_by[direction]: change the sort order. Send both: sending only one doesn't apply the documented default for the other.

Results are paginated: 10 payments per page by default. The response includes a pagination_meta object; see Pagination for how to fetch every page.

Query Params
integer
integer
1 to 1000

Number of payments per page (1 to 1000, default 10).

date

Only return payments created on or after this date (inclusive). Format YYYY-MM-DD.

date

Only return payments created on or before this date (inclusive). Format YYYY-MM-DD.

string
enum
Defaults to created_at

The field to sort payments by.

Allowed:
string
enum
Defaults to desc

The sort direction.

Allowed:
Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json