Create a new External Account
Note: If adding US external accounts, we recommend reading through the US Beneficiary Address Validation doc (link) to avoid issues related to incorrect addresses.
Authorizations
Headers
Path Parameters
A UUID that uniquely identifies a resource
1 - 42[a-z0-9]*Body
New External Account object to be created
- ACH/Wire
- IBAN
- SWIFT
- CLABE
- Pix (Pix Key)
- Pix (BR Code)
- FPS (beta)
Request body for creating an external account.
Type of the bank account.
us Currency associated with the bank account. Must be usd for US accounts.
usd Bank name of the account (e.g. "Chase")
1 - 256Owner 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 - 256The 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.
Account 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.
9Response
External Account object created
- ACH/Wire
- IBAN
- SWIFT
- CLABE
- Pix
- GB
US bank account using account and routing numbers for ACH or Wire transfers
A UUID that uniquely identifies a resource
1 - 42[a-z0-9]*The id of the Bridge customer that this External Account belongs to
1Owner 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 - 256Time of creation of the External Account
Time of last update of the External Account
Whether or not this External Account is active
Type of the bank account.
us Currency associated with the bank account. Must be usd for US accounts.
usd Bank name of the account (e.g. "Chase")
1 - 256The 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
Reason for deactivation when this External Account is inactive
plaid_item_error, deactivated_due_to_bounceback, deleted_by_developer, requested_by_developer, invalid_account_number, invalid_bank_validation, rejected_by_bank_provider Additional details about the deactivation when this External Account is inactive
Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts
Last 4 digits of the bank account number. This field is getting deprecated in favor of the account.last_4 field
1Present for Pix and SPEI/CLABE accounts with a successful validation; contains validated owner and bank name.