Sign in
refunds

Create referenced refund

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

To refund 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 refund is successful, our gateway returns the payment amount to the customer's account.

Things to consider

  • If the merchant refunds a bank transfer payment that is in an open batch, our gateway reverses the bank transfer 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/bank-transfer-payments/{paymentId}/refund

Path parameters

paymentIdstring required

Unique identifier that our gateway assigned to the payment.

Headers

Authorizationstring required

Bearer authentication

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

amountinteger required

Total amount of the refund. The value is in the currency's lowest denomination, for example, cents.

descriptionstring required

Description of the refund.

Response

Successful request. We refunded the payment.

paymentIdstring required

Unique identifier that we assigned to the payment.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Changes

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