SchemaPaymentsBank Transfer Payments

Reverse payment

Cancel a payment in an open batch.

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.

Response

Successful request. We voided 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
Object that contains information about a payment.
customFieldslist of objects or null
Array of customField objects.

Errors