SchemaPaymentsBank Transfer Refunds

List refunds

Use this method to return a paginated list of bank transfer refunds.

Note: If you want to view a specific refund and you have its refundId, use our Retrieve Refund method.

Use query parameters to filter the list of results that we return, for example, to search for refunds for a customer, an orderId, or a date range.

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

  • Order details, including the refund amount and when it was processed.
  • Bank account details, including the customer’s name and account number.

For referenced refunds, our gateway also returns details about the payment that the refund is linked to.

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 refund.
nameOnAccountstringOptional>=1 character<=50 characters
Filter results by the accountholder'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 refund.
dateFromdatetimeOptional

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

dateTodatetimeOptional

Filter results by refunds 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.

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

Errors