Skip to main content
POST
Validates an external bank account using micro-deposits.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.

Path Parameters

id
string<uuid>
required

The external bank account ID.

Body

The validate request.

Request to validate an external bank account using micro-deposits.

firstAmount
required

First micro-deposit verification amount in minor units (e.g. cents for USD).

secondAmount
required

Second micro-deposit verification amount in minor units (e.g. cents for USD).

Response

External bank account validated.

Response representing an external bank account.

id
string<uuid>
required

Unique identifier for the external bank account.

accountNumber
string
required

Masked account number (last 4 digits visible).

accountStatus
enum<string>
required

Status of the external bank account.

Available options:
ACTIVE,
INACTIVE
nameOnAccount
string
required

Name on the bank account.

nickname
string
required

Nickname for the external bank account.

routingNumber
string
required

Bank routing number (ABA number).

type
enum<string>
required

Type of bank account (checking or savings).

Available options:
CHECKING,
SAVINGS
verificationStatus
enum<string>
required

Verification status of the external bank account.

Available options:
UNVERIFIED,
VERIFICATION_SENT,
VERIFIED,
FAILED