SchemaPaymentsBank Transfer Refunds

Create refund

Send a refund to a customer’s bank account. The refund transaction is not linked to the previous transaction.
Note: This function is available to only certain merchant accounts.

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.
processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

orderobjectRequired

Object that contains information about the order.

refundMethodobjectRequired

Object that contains information about how the merchant refunds the customer.

customFieldslist of objectsOptional

Array of customField objects.

Response

Successful request. We sent the refund to the customer’s bank account.

refundIdstring=10 characters

Unique identifier that our gateway assigned to the refund.

processingTerminalIdstring>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

orderobject

Object that contains information about the order.

bankAccountobject

Object that contains information about the bank account.

transactionResultobject

Object that contains information about the transaction.

customerobjectOptional

Object that contains information about the customer.

paymentobjectOptional

Object that contains information about a payment.

customFieldslist of objectsOptional

Array of customField objects.

Errors