SchemaPaymentsBank Transfer Payments

List payments

Retrieve a list of payments.

Headers

AuthorizationstringRequired

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

Query parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

Filter payments by the unique identifier that our gateway assigned to the terminal.

orderIdstringOptional>=1 character<=24 characters

Filter payments by the order ID.

nameOnAccountstringOptional>=1 character<=50 characters

Filter payments by the account holder’s name.

last4stringOptionalformat: "[0-9]{4}"

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

typelist of enumsOptional

Filter payments by transaction type.

statuslist of enumsOptional

Filter by the status of the payment.

dateFromstringOptionalformat: "date-time"

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

dateTostringOptionalformat: "date-time"

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

settlementStateenumOptional

Filter by the settlement status of the payment.

Allowed values:
settlementDatestringOptionalformat: "date"

Filter by payments settled on a specific date. The format is in 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.

datalist of objects

Array of payments.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.