Sign in
Payments

List payments

Use this method to return a paginated list of payments.

Note: If you want to view the details of 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.

get/payments

Query parameters

processingTerminalIdstring

Filter by terminal ID.

orderIdstring

Filter payments by order ID.

operatorstring

Filter payments by operator.

cardholderNamestring

Filter payments by the cardholder’s name.

first6string

Filter payments by the first six digits of the card number that the customer used in the transaction.

last4string

Filter payments by the last four digits of the card number that the customer used in the transaction.

tender'ebt' | 'creditDebit'

Filter by tender type.

tipModePaymentsGetParametersTipModeSchemaItems[]

Filter payments by tip.

typePaymentsGetParametersTypeSchemaItems[]

Filter payments by transaction type.

statusPaymentsGetParametersStatusSchemaItems[]

Filter payments by the status of the transaction.

dateFromstring date-time

Filter by payments that the processor processed after a specific date. The date format follows the ISO 8601 standard.

dateTostring date-time

Filter by payments that the processer processed before a specific date. The date format follows the ISO 8601 standard.

settlementState'settled' | 'unsettled'

Filter payments by the settlement status of the transaction.

settlementDatestring date

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

paymentLinkIdstring

Unique identifier that our gateway assigned to the payment link.

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a list of payments.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.