Retrieve a list of your payments.
Results are paginated, they will only return up to 100 payments maximum.
To access the next page of result, set the cursor
query parameter to the value of nextCursor
in
your current result payload. Use prevCursor
to go back to the previous page.
Note: this endpoint returns a list of
summarized payments. Not all payments attributes are present. You can use
the query parameters to filter payments. You can separate multiple query parameters with the &
symbol.
Query parameters with types of the form “Array of strings” (such as the status parameter) can be specified as a comma-separated list.
For example, if you wanted to get both FAILED
and CANCELLED
payments, for customer john-123
, you would use:
You can alternatively specify a list by repeating the parameter multiple times.
Note: payments will be available within a minute from being created.
Filter payments by their status.
Filter payments by their payment method type.
Filter payments by their payment processor.
Filter payments by their payment currency.
e.g. use USD
for US dollars.
Return only payments from this date (inclusive).
Return only payments up to this date (inclusive).
Return payments related to this order ID.
Return payments of this amount minimum (inclusive).
Return payments of this amount max (inclusive).
ID of the customer that has made the payment.
ID of the merchant involved in the payment.
Email of the customer that has made the payment.
Last 4 digits of the card used for the payment.
Paypal email address associated with the payment.
Klarna email address associated with the payment.
Maximum number of payments to return per page.
If results are paginated, pass the nextCursor
to access next page.