Skip to main content
Use the dedicated endpoint to retrieve a list of payments. List payments

Request

Sample request:
Query parameters:
  • from: start of the date range on the payment creation date, here 2023-01-01T00:00:00.000Z.
  • to: end of the date range on the payment creation date, here 2023-01-01T12:00:00.000Z.
  • page and perPage: navigate through the result pages. perPage defaults to 10.
  • isDelegated (optional): true returns only Processing Only payments, false only the others. When this parameter is set, from is required and the date range must be shorter than one year.
This endpoint is rate limited to 1 request every 30 seconds. Beyond that limit, the API returns HTTP 429 - Too Many Requests.
Under high traffic, all payments cannot be retrieved without pagination.

Pagination

The Content-Range response header gives the range of the returned results, for example 0-99/999999. The value after the slash is not an exact count of the matching payments.
To retrieve every payment of a date range, request the next page until a page returns fewer results than perPage. Always set the date filters as well, so that the result set does not change between two requests.

Response

Results are sorted by creation date, in descending order.
The response is an array of Payment objects: