refunds

Retrieve refund

Changed on

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}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/refunds/{refundId}
  • Auth
    HTTP bearer

Path parameters

refundIdstring required

Unique identifier that our gateway assigned to the refund.

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

  • 817f57a896f3Revision changes
    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API