Create ExternalBankAccount

post

https://bank.sandbox.cybrid.app/api/external_bank_accounts

Create an ExternalBankAccount.

Account creation

Accounts can be created for a Bank or a Customer.

To create accounts for your Bank, omit the customer_guid parameter in the request body. To create accounts for your Customers, include the customer_guid parameter in the request body.

State

State	Description
storing	The Platform is storing the external bank account details in our private store
completed	The Platform has created the external bank account
unverified	The external bank account is created, but it has not yet been verified
failed	The Platform was not able to successfully create the external bank account
refresh_required	The Platform has created the external bank account, but needs to be refreshed
deleting	The Platform is deleting the external bank account
deleted	The Platform has deleted the external bank account

Failure codes

Code	Description
invalid_routing_number	The provided routing number is invalid
invalid_account_number	The account number is invalid
invalid_account_type	The account type is invalid
duplicate	An account with the same details already exists
plaid_processor_token	An account could not be created due to an invalid Plaid processor token or an error with Plaid
plaid_multiple_accounts	The supplied Plaid token is associated with multiple accounts. Must only be a single account.
create_failed	The bank account and associated holder could not be created correctly
unverified_counterparty	The counterparty account is unverified

Required scope: external_bank_accounts:execute

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 1 and 128

The name of the account.

account_kind

string

enum

required

The account type

Allowed:

customer_guid

string | null

The customer identifier.

asset

string | null

The asset code. If not set will try and default to the Bank's configured fiat asset.

plaid_public_token

string | null

The public token for the account. Required for 'plaid' accounts. Required when account_kind is plaid.

plaid_account_id

string | null

The account identifier in plaid. Required for 'plaid' accounts. Required when account_kind is plaid.

plaid_processor_token

string | null

The Plaid processor token used to access the account. Required when account_kind is plaid_processor_token.

plaid_institution_id

string | null

Plaid's institution ID for the account's institution. Required when account_kind is plaid_processor_token.

plaid_account_mask

string | null

The account mask for the account. Required when account_kind is plaid_processor_token.

plaid_account_name

string | null

The name of the account. Required when account_kind is plaid_processor_token.

counterparty_guid

string | null

The counterparty identifier. Optional when account_kind is raw_routing_details.

counterparty_bank_account_details

array of objects | null

The counterparty's checking bank account information. Required when account_kind is raw_routing_details.

counterparty_bank_account_details

counterparty_name

object | null

The counterparty's name on their checking account. Required when account_kind is raw_routing_details and counterparty_guid is not present.

counterparty_address

object | null

The counterparty's address on their checking account. Required when account_kind is raw_routing_details and counterparty_guid is not present.

counterparty_email_address

string | null

The counterparty's email address on their checking account. Optional when account_kind is raw_routing_details and counterparty_guid is not present.

Responses

201ExternalBankAccount created

400Bad Request

401Unauthorized - Authentication failed,

403Invalid scope

422Unprocessable Content