SchemaPaymentsBank Transfer Payments

Refund payment

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.

Path parameters

paymentIdstringRequired=10 characters
Unique identifier that our gateway assigned to the payment.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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

This endpoint expects an object.
amountlongRequired
Total amount of the refund. The value is in the currency's lowest denomination, for example, cents.
descriptionstringRequired>=1 character<=100 characters
Description of the refund.

Response

Successful request. We refunded the payment.
paymentIdstring=10 characters
Unique identifier that we assigned to the payment.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobject
Object that contains information about the transaction.
bankAccountobject
Object that contains information about the bank account.
transactionResultobject
Object that contains information about the transaction.
customerobject or null
Object that contains information about the customer.
refundslist of objects or null
List of refunds issued against the payment.
returnslist of objects or null
List of returns issued against the payment.
representmentobject or null

List of re-presented payments linked to the return.

customFieldslist of objects or null
Array of customField objects.

Errors