SchemaPaymentsBank Transfer Payments

Refund payment

Refund a payment.

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.

customerobjectOptional

Object that contains information about the customer.

refundslist of objectsOptional

List of refunds issued against the payment

returnslist of objectsOptional

List of returns issued against the payment

representmentobjectOptional

Object that contains information about a payment.

customFieldslist of objectsOptional

Array of customField objects.