Skip to main content
POST
Links an external bank account by initiating micro-deposit verification.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

Micro-deposit verification initiated.

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