refunds

Reverse refund

Changed on

Use this method to cancel a refund in an open batch.

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

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

If your request is successful, the gateway removes the refund from the merchant’s open batch and no funds are returned to the cardholder’s account.

post/refunds/{refundId}/reverse

Request

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

Path parameters

refundIdstring required

Unique identifier that our gateway assigned to the refund.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Response

Successful request. We voided the 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