Authorizations
Headers
Path Parameters
A UUID that uniquely identifies a resource
1 - 42Query Parameters
The number of items to return (default of 10, max of 100)
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)
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
New External Account object to be created
A UUID that uniquely identifies a resource
1 - 42Owner 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!"#$%&'()+,\-./:;<=>?@\\_`~]*$
1 - 256IBAN bank account information. Required when the account_type is iban.
Currency associated with the bank account. Default is usd. When eur is specified, the account type must be iban
usd, eur, mxn Bank name of the account (e.g. "Chase")
1 - 256Account number of your bank account. This field is getting deprecated in favor of the account.account_number field for US accounts.
12Routing number of your bank account. This field is getting deprecated in favor of the account.routing_number field for US accounts.
9Type of the bank account. The default is us
us, iban, clabe, unknown 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.
SWIFT bank account information. Required when using SWIFT payment rails. Supported account types are iban and unknown.
Mexican CLABE bank account information for SPEI payment rails. Required when account type is clabe.
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.
individual, business First name of the individual account holder. Required when the account_owner_type is individual
Last name of the individual account holder. Required when the account_owner_type is individual
Business name of the business account holder. Required when the account_owner_type is business
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.
Response
External Account object created
A UUID that uniquely identifies a resource
1 - 42The id of the Bridge customer that this External Account belongs to
1Currency associated with the bank account. Default is usd. When eur is specified, the account type must be iban
usd, eur, mxn 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!"#$%&'()+,\-./:;<=>?@\\_`~]*$
1 - 256Type of the bank account. The default is us
us, iban, clabe, unknown IBAN bank account information. Required when the account_type is iban.
IBAN bank account information. It's populated when the account_type is iban.
Time of creation of the External Account
Time of last update of the External Account
Whether or not this External Account is active
Bank name of the account (e.g. "Chase")
1 - 256Last 4 digits of the bank account number for us account type. This field is getting deprecated in favor of the account.last_4 field
1US 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
SWIFT bank account information. Required when using SWIFT payment rails. Supported account types are iban and unknown.
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.
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.
Type of the account ownership
individual, business First name of the individual account holder. Required when the account_owner_type is individual
First name of the individual account owner
Last name of the individual account holder. Required when the account_owner_type is individual
Last name of the individual account owner
Business name of the business account holder. Required when the account_owner_type is business
Business name of the business account owner
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.
Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts