SchemaPaymentsBank Transfer Refunds

List refunds

Return a list of refund transactions.

Headers

AuthorizationstringRequired

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

Query parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

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

orderIdstringOptional>=1 character<=24 characters

Filter by the order ID.

nameOnAccountstringOptional>=1 character<=50 characters

Filter by the account holder’s name.

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

Filter by the last four digits of the account number.

typelist of enumsOptional

Filter refunds by transaction type.

statuslist of enumsOptional

Filter by the status of the refund.

dateFromstringOptionalformat: "date-time"

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

dateTostringOptionalformat: "date-time"

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

settlementStateenumOptional

Filter by the settlement status of the refund.

Allowed values:
settlementDatestringOptionalformat: "date"

Filter by refund transactions settled on a specific date. The date format is YYYY-MM-DD.

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

datalist of objects

Array of refund transactions.

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.