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:
curl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \
--header 'X-Api-Key: <YOUR_API_KEY>'
You can alternatively specify a list by repeating the parameter multiple times.
Note: payments will be available within a minute from being created.