Skip to main content
GET
Get payments

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:50

The desired amount of records per page.

Required range: 1 <= x <= 500
page
integer

The desired number of the page to return.

Required range: x >= 1
from
string<YYYY-MM-DD>

Return only payments created from this date.

to
string<YYYY-MM-DD>

Return only payments created up to this date.

currency_code
string

Return only payments with the specified currencies.

Currencies are in ISO 4217 and use a list formats, e.g.:

  • currency_code=EUR
  • currency_code=EUR,USD
status
string

Return only payments with the specified status.

Status are given as a list, e.g.:

  • status=authorized
  • status=authorized,captured.

Response

Success response

data
object[]
pagination
object

The meta-data describing lists of data from the Commerce API. The pages are indexed from 1 up to the total_pages.

Example: