refunds

Reverse payment

Changed on

Use this method to cancel a bank transfer payment in an open batch. This is also known as voiding a payment.

To cancel a bank transfer 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 bank transfer payment.

If your request is successful, our gateway removes the bank transfer payment from the merchant’s open batch and no funds are taken from the customer's bank account.

post/bank-transfer-payments/{paymentId}/reverse

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/bank-transfer-payments/{paymentId}/reverse
  • Auth
    HTTP bearer

Path parameters

paymentIdstring required

Unique identifier that our gateway assigned to the payment.

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

paymentIdstring required

Unique identifier that we assigned to the payment.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

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