Sign in
refunds

List refunds

Use this method to return a paginated list of refunds.

Note: If you want to view the details of 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.

get/refunds

Query parameters

processingTerminalIdstring

Filter by terminal ID.

orderIdstring

Filter refunds by the unique identifier that the merchant assigned to the order.

operatorstring

Filter refunds by the operator who initiated the request.

cardholderNamestring

Filter refunds by cardholder name.

first6string

Filter refunds by the first six digits of the card number.

last4string

Filter refunds by the last four digits of the card number.

tender'ebt' | 'creditDebit'

Filter by tender type.

statusRefundsGetParametersStatusSchemaItems[]

Filter refunds by the current status of the refund.

dateFromstring date-time

Filter by refunds processed after a specific date. The date format follows the ISO 8601 standard.

dateTostring date-time

Filter by refunds processed before a specific date. The date format follows the ISO 8601 standard.

settlementState'settled' | 'unsettled'

Status of the settlement.

settlementDatestring date

Date the transaction was settled.

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a paginated list of refunds.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean required

Indicates whether there is another page of results available.

Changes

No recorded changes to this endpoint across all 1 revision of this API.