SchemaPaymentsBank Transfer Payments

Create payment

Use this method to run a sale with a customer’s bank account details.

In the response, our gateway returns information about the bank transfer payment and a paymentId, which you need for the following methods:

  • Retrieve payment - View the details of the bank transfer payment.
  • Reverse payment - Cancel the bank transfer payment if it’s an open batch.
  • Refund payment - Run a referenced refund to return funds to the customer’s bank account.

Payment methods

Our gateway accepts the following payment methods:

  • Automated clearing house (ACH) details
  • Pre-authorized debit (PAD) details

You can also use secure tokens and single-use tokens that you created from ACH details or PAD details.

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.

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

List of re-presented payments linked to the return.

customFieldslist of objects or null
Array of customField objects.

Errors