SchemaPaymentsBank Transfer Payments

Create payment

Run a sale with a customer’s bank account details.

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

paymentMethodobjectRequired

Object that contains information about the customer’s payment details.

customerobjectOptional

Object that contains information about the customer.

credentialOnFileobjectOptional

Object that contains information about saving the customer’s payment details.

customFieldslist of objectsOptional

Array of customField objects.

Response

Successful request. We processed the sale.

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.