Skip to main content
POST
Connect external account

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.

Body

The connect request.

Request to connect a new external bank account.

accountNumber
string
required

External bank account number.

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
accountHolderType
null | enum<string>

Holder of the bank account (individual or business). Optional.

Available options:
INDIVIDUAL,
BUSINESS
verification
null | object

Optional verification to apply at creation time. Only MANUAL method is supported. Requires 'external_bank_account:set_verification:org' scope.

Response

External bank account connected.

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. Where the bank fails verification on the first incorrect attempt, FAILED can be recovered while attempts remain. Where it fails at the attempt limit, or after a returned micro-deposit or a notification of change, FAILED is final.

Available options:
UNVERIFIED,
VERIFICATION_SENT,
VERIFIED,
FAILED
accountHolderType
null | enum<string>

Holder of the bank account (individual or business).

Available options:
INDIVIDUAL,
BUSINESS
microDepositVerification
null | object

Result of the micro-deposit validation attempt. Returned by the validate endpoint only.

suspension
null | object

Why no payment may be sent to or taken from the account, or null when it is usable.

verificationFailure
null | object

Why verification failed, when verificationStatus is FAILED.