Create a new External Account

Authorizations

Api-Key

string

header

required

Headers

Idempotency-Key

string

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Query Parameters

limit

integer

The number of items to return (default of 10, max of 100)

starting_after

string

This is an external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending_before is set)

ending_before

string

This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting_after is set)

Body

application/json

New External Account object to be created

ACH
IBAN
SWIFT
CLABE
PIX

US ACH bank account using account and routing numbers

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

account_owner_name

string

required

Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns:

ach: ^(?!\s*$)[\x20-\x7E]*$
wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$

Required string length: 1 - 256

account

object

required

US bank account information. Required when the account_type is us. However, the top-level account_number and routing_number fields in deprecation will continue to be supported.

Show child attributes

currency

enum<string>

Currency associated with the bank account. Default is usd. When eur is specified, the account type must be iban. When brl is specified, the account type must be pix

Available options:

usd,

eur,

mxn

bank_name

string

Bank name of the account (e.g. "Chase")

Required string length: 1 - 256

account_number

string

Account number of your bank account. This field is getting deprecated in favor of the account.account_number field for US accounts.

Minimum length: 12

routing_number

string

Routing number of your bank account. This field is getting deprecated in favor of the account.routing_number field for US accounts.

Minimum length: 9

account_type

enum<string>

Type of the bank account. The default is us

Available options:

us

iban

object

IBAN bank account information. Required when the account_type is iban.

Show child attributes

swift

object

SWIFT bank account information. Required when using SWIFT payment rails. Supported account types are iban and unknown.

Show child attributes

clabe

object

Mexican CLABE bank account information for SPEI payment rails. Required when account type is clabe.

Show child attributes

pix

object

Brazilian PIX bank account information. Required when account type is pix.

Show child attributes

account_owner_type

enum<string>

The type of the account ownership. Required when the account_type is iban. For individual ownership, first_name and last_name are required. For business ownership, business_name is required.

Available options:

individual,

business

first_name

string

First name of the individual account holder. Required when the account_owner_type is individual

last_name

string

Last name of the individual account holder. Required when the account_owner_type is individual

business_name

string

Business name of the business account holder. Required when the account_owner_type is business

address

object

Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number.

Show child attributes

Response

External Account object created

ACH
IBAN
SWIFT
CLABE
PIX

US ACH bank account using account and routing numbers

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

customer_id

string

required

The id of the Bridge customer that this External Account belongs to

Minimum length: 1

currency

enum<string>

required

Currency associated with the bank account. Default is usd. When eur is specified, the account type must be iban. When brl is specified, the account type must be pix

Available options:

usd,

eur,

mxn

account_owner_name

string

required

Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns:

ach: ^(?!\s*$)[\x20-\x7E]*$
wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$

Required string length: 1 - 256

account_type

enum<string>

required

Type of the bank account. The default is us

Available options:

us

account

object

required

US bank account information. Required when the account_type is us. However, the top-level account_number and routing_number fields in deprecation will continue to be supported. US bank account information. It's populated when the account_type is us

Show child attributes

created_at

string<date-time>

required

Time of creation of the External Account

updated_at

string<date-time>

required

Time of last update of the External Account

active

boolean

required

Whether or not this External Account is active

bank_name

string

Bank name of the account (e.g. "Chase")

Required string length: 1 - 256

last_4

string

deprecated

Last 4 digits of the bank account number for us account type. This field is getting deprecated in favor of the account.last_4 field

Minimum length: 1

iban

object

IBAN bank account information. Required when the account_type is iban. IBAN bank account information. It's populated when the account_type is iban.

Show child attributes

swift

object

SWIFT bank account information. Required when using SWIFT payment rails. Supported account types are iban and unknown.

Show child attributes

clabe

object

Mexican CLABE bank account information for SPEI payment rails. Required when account type is clabe. CLABE bank account information for the SPEI (Mexican) payment rail. It's populated when the account_type is clabe.

Show child attributes

pix

object

Brazilian PIX bank account information. Required when account type is pix. PIX bank account information for the Brazilian PIX payment rail. It's populated when the account_type is pix. Contains either PIX key or BR Code information.

Show child attributes

account_owner_type

enum<string>

Available options:

individual,

business

first_name

string

First name of the individual account holder. Required when the account_owner_type is individual First name of the individual account owner

last_name

string

Last name of the individual account holder. Required when the account_owner_type is individual Last name of the individual account owner

business_name

string

Business name of the business account holder. Required when the account_owner_type is business Business name of the business account owner

address

object

Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number.

Show child attributes

beneficiary_address_valid

boolean

Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts

Endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response