SchemaPayments

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

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

processingTerminalIdstringOptional>=4 characters<=50 characters
Filter by terminal ID.
orderIdstringOptional>=1 character<=24 characters
Filter payments by order ID.
operatorstringOptional>=1 character<=50 characters
Filter payments by operator.
cardholderNamestringOptional>=1 character<=50 characters

Filter payments by the cardholder’s name.

first6stringOptionalformat: "[0-9]{6}"
Filter payments by the first six digits of the card number that the customer used in the transaction.
last4stringOptionalformat: "[0-9]{4}"
Filter payments by the last four digits of the card number that the customer used in the transaction.
tenderenumOptional
Filter by tender type.
Allowed values:
tipModelist of enumsOptional
Filter payments by tip.
Allowed values:
typelist of enumsOptional
Filter payments by transaction type.
Allowed values:
statuslist of enumsOptional
Filter payments by the status of the transaction.
dateFromdatetimeOptional
Filter by payments that the processor processed after a specific date. The date format follows the ISO 8601 standard.
dateTodatetimeOptional
Filter by payments that the processer processed before a specific date. The date format follows the ISO 8601 standard.
settlementStateenumOptional
Filter payments by the settlement status of the transaction.
Allowed values:
settlementDatedateOptional

Filter by payments that the processor settled on a specific date in the format YYYY-MM-DD.

paymentLinkIdstringOptional=10 characters
Unique identifier that our gateway assigned to the payment link.
beforestringOptional
Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.
afterstringOptional
Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.
limitintegerOptional<=100Defaults to 10
States the total amount of results the response is limited to.

Response

Successful request. Returns a list of payments.
limitdouble
Maximum number of results that we return for each page.
countdouble
Number of results that we returned.
hasMoreboolean
Indicates that further results are available.
datalist of objects
Array of transactions.

Errors