List payments
Use this method to return a paginated list of payments.
Note: If you want to view a specific payment and you have its paymentId, use our Retrieve Payment method.
Use query parameters to filter the list of results that we return, for example, to search for payments for a customer, a tip mode, or a date range.
Our gateway returns the following information about each payment in the list:
- Order details, including the transaction amount and when it was processed.
- Payment card details, including the masked card number, expiry date, and payment method.
- Cardholder details, including their contact information and shipping address.
- Payment details, including the payment type, status, and response.
For each transaction, we also return the paymentId and an optional secureTokenId, which you can use to perform follow-on actions.
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
Filter payments by the cardholder’s name.
Filter by payments that the processor settled on a specific date in the format YYYY-MM-DD.