SchemaPaymentsBank Transfer Refunds

Reverse refund

Use this method to cancel a bank transfer refund in an open batch.

To cancel a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment or Create Refund method.

Note: If you don’t have the refundId, use our List Refunds method to search for the refund.

If your request is successful, the gateway removes the refund from the merchant’s open batch, and no funds are returned to the cardholder’s account.

Path parameters

refundIdstringRequired=10 characters
Unique identifier that our gateway assigned to the refund.

Headers

AuthorizationstringRequired

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

Idempotency-KeystringRequiredformat: "uuid"

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 reversed the refund transaction.
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.
customerobject or null
Object that contains information about the customer.
paymentobject or null
Object that contains information about a payment.
customFieldslist of objects or null
Array of customField objects.

Errors