Add a new bank account for the specified entity.
The minimum required fields are currency and country. Other required fields depend on the currency:
iban.account_holder_name, account_number, and sort_code.account_holder_name, account_number, and routing_number.ibanaccount_number and sort_codeaccount_number and routing_numberThe ID of the entity that owns the requested resource.
The country in which the bank account is registered, repsesented as a two-letter country code (ISO 3166-1 alpha-2).
The name of the person or business that owns this bank account. Required if the account currency is GBP or USD.
The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits.
The bank name.
The SWIFT/BIC code of the bank.
User-defined name of this bank account, such as ‘Primary account’ or ‘Savings account’.
The IBAN of the bank account. Required if the account currency is EUR.
If set to true or if this is the first bank account added for the given currency, this account becomes the default one for its currency.
The bank’s routing transit number (RTN). Required if the account currency is USD. US routing numbers consist of 9 digits.
The bank’s sort code. Required if the account currency is GBP.
Successful Response
Unique ID of the bank account.
The name of the person or business that owns this bank account. Required if the account currency is GBP or USD.
The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits.
The bank name.
The SWIFT/BIC code of the bank.
The country in which the bank account is registered, repsesented as a two-letter country code (ISO 3166-1 alpha-2).
User-defined name of this bank account, such as ‘Primary account’ or ‘Savings account’.
The IBAN of the bank account. Required if the account currency is EUR.
Indicates whether this bank account is the default one for its currency.
The bank’s routing transit number (RTN). Required if the account currency is USD. US routing numbers consist of 9 digits.
The bank’s sort code. Required if the account currency is GBP.
ID of the entity user who added this bank account, or null if it was added using a partner access token.