SchemaPaymentsBank Transfer Refunds

Create refund

Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn’t linked to a bank transfer payment.

Note: If you have the paymentId of the payment you want to refund, use our Refund Payment method. If you use our Refund Payment method, our gateway sends the refund amount to the customer’s original payment method and links the refund to the payment.

In the request, you must provide the customer’s payment method and information about the order including the refund amount.

In the response, our gateway returns information about the refund and a refundId, which you need for the following methods:

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