refunds

Create referenced refund

Changed on

Use this method to refund a payment that is in a closed batch.

To refund a payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.

Note: If you don't have the paymentId, use our List Payments method to search for the payment.

If your refund is successful, our gateway returns the payment amount to the cardholder's account.

Things to consider

  • If the merchant refunds a payment that is in an open batch, our gateway reverses the payment.
  • Some merchants can run unreferenced refunds, which means that they don't need a paymentId to return an amount to a customer. For more information about how to run an unreferenced refund, go to Create Refund.
post/payments/{paymentId}/refund

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/payments/{paymentId}/refund
  • Auth
    HTTP bearer

Path parameters

paymentIdstring required

Unique identifier of the payment that the merchant wants to retrieve.

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.

Request body

operatorstring

Operator who refunded the payment.

amountinteger required

Amount of the payment that the merchant wants to refund. The value is in the currency’s lowest denomination, for example, cents.

descriptionstring required

Reason for the refund.

Response

Successful request. We refunded the payment.

paymentIdstring required

Unique identifier that our gateway assigned to the transaction.

processingTerminalIdstring required

Unique identifier of the terminal that initiated the transaction.

operatorstring

Operator who initiated the request.

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

    • info

      added the optional property // to the response with the status

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API