Sign in
refunds

Retrieve refund

Use this method to retrieve information about a refund.

To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment method or the Create Refund method.

Note: If you don't have the refundId, use our List Refunds method to search for the refund.

Our gateway returns the following information about the refund:

  • 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.

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

get/refunds/{refundId}

Path parameters

refundIdstring required

Unique identifier that our gateway assigned to the refund.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns the specific refund.

refundIdstring required

Unique identifier that our gateway assigned to the refund.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

operatorstring

Operator who requested the refund.

supportedOperationsSupportedOperationsItems[]

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

Changes

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