SchemaPaymentsRefunds

List refunds

Use this method to return a paginated list of 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, a tender type, or a date range. Our gateway returns the following information about each refund in the list:

  • Order details, including the refund amount and when we processed the refund.
  • Payment card details, including the masked card number, expiry date, and payment method.
  • Cardholder details, including their contact information and shipping address.

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

processingTerminalIdstringOptional>=4 characters<=50 characters
Filter by terminal ID.
orderIdstringOptional>=1 character<=24 characters
Filter refunds by the unique identifier that the merchant assigned to the order.
operatorstringOptional>=1 character<=50 characters
Filter refunds by the operator who initiated the request.
cardholderNamestringOptional>=1 character<=50 characters
Filter refunds by cardholder name.
first6stringOptionalformat: "[0-9]{6}"
Filter refunds by the first six digits of the card number.
last4stringOptionalformat: "[0-9]{4}"
Filter refunds by the last four digits of the card number.
tenderenumOptional
Filter by tender type.
Allowed values:
statuslist of enumsOptional
Filter refunds by the current status of the refund.
dateFromdatetimeOptional
Filter by refunds processed after a specific date. The date format follows the ISO 8601 standard.
dateTodatetimeOptional
Filter by refunds processed before a specific date. The date format follows the ISO 8601 standard.
settlementStateenumOptional
Status of the settlement.
Allowed values:
settlementDatedateOptional
Date the transaction was settled.
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 paginated list of refunds.
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 objects.

Errors