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 date range, or a settlement state.

Our gateway returns the following information about each payment in the list:

  • Order details, including the transaction amount and when it was processed.
  • Bank account details, including the customer’s name and account number.
  • Customer's details, including the customer’s phone number.
  • Transaction details, including any refunds or re-presentments.

For each transaction, we also return the paymentId and an optional secureTokenId, which you can use to perform follow-on actions.

get/bank-transfer-payments

Query parameters

processingTerminalIdstring required

Filter results by the unique identifier that we assigned to the terminal.

orderIdstring

Filter results by the order ID of the payment.

nameOnAccountstring

Filter results by the account holder's name.

last4string

Filter results by the last four digits of the account number.

typeBankTransferPaymentsGetParametersTypeSchemaItems[]

Filter results by transaction type.

statusBankTransferPaymentsGetParametersStatusSchemaItems[]

Filter results by the status of the payment.

dateFromstring date-time

Filter results by payments that the merchant ran after a specific date. The value follows the ISO 8601 standard.

dateTostring date-time

Filter results by payments that the merchant ran before a specific date. The value follows the ISO 8601 standard.

settlementState'settled' | 'unsettled'

Filter results by the settlement status.

settlementDatestring date

Filter results by the settlement date. Send a value in YYYY-MM-DD format.

paymentLinkIdstring

Filter results by the paymentLinkId.

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.