SchemaPaymentsBank Accounts

Verify bank account

Use this method to verify a customer’s bank account details.

In the request, send the customer’s bank account details. Our gateway can verify the following types of bank details:

  • Automated Clearing House (ACH) details
  • Pre-Authorized Debit (PAD) details

In the response, our gateway indicates if the account details are valid and if you should use them in follow-on actions.

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.
bankAccountobjectRequired
Object that contains information about the bank account.

Response

Successful request. Returns the verification status of the customer's bank account details.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
verifiedboolean

Indicates if the customer’s bank account details are valid.

  • true - Account details are valid.
  • false - Account details are not valid.

Errors