SchemaPaymentsBank Transfer Payments

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 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.

Headers

AuthorizationstringRequired

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

Query parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Filter results by the unique identifier that we assigned to the terminal.
orderIdstringOptional>=1 character<=24 characters
Filter results by the order ID of the payment.
nameOnAccountstringOptional>=1 character<=50 characters
Filter results by the account holder's name.
last4stringOptionalformat: "[0-9]{4}"
Filter results by the last four digits of the account number.
typelist of enumsOptional
Filter results by transaction type.
Allowed values:
statuslist of enumsOptional
Filter results by the status of the payment.
dateFromdatetimeOptional

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

dateTodatetimeOptional

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

settlementStateenumOptional
Filter results by the settlement status.
Allowed values:
settlementDatedateOptional

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

paymentLinkIdstringOptional=10 characters
Filter results by the paymentLinkId.
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 payments.

Errors