CommonEntity bank accounts

Create an entity bank account

Adds a new bank account for the specified entity. The minimum required fields are `currency` and `country`. Other required fields depend on the currency and country. Bank accounts in African countries can use any fields or combinations of fields. For other countries: * EUR accounts require `iban`. * GBP accounts require `account_holder_name`, `account_number`, and `sort_code`. * USD accounts require `account_holder_name`, `account_number`, and `routing_number`. * Accounts in other currencies require one of: * `iban` * `account_number` and `sort_code` * `account_number` and `routing_number`

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
countryenumRequired
The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
currencyenumRequired

The currency of the bank account, represented as a three-letter ISO currency code.

account_holder_namestringOptional>=1 character<=200 characters
The name of the person or business that owns this bank account. Required in the following cases: * the account currency is GBP or USD, * the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account.
account_numberstringOptional
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.
bank_namestringOptional
The bank name.
bicstringOptional

The SWIFT/BIC code of the bank. Can be either 8 or 11 characters long. Monite verifies the BIC length, country code, and whether the structure conforms to ISO 9362.

If bic is specified, iban must also be specified.

display_namestringOptional>=1 character<=200 characters

User-defined name of this bank account, such as ‘Primary account’ or ‘Savings account’.

ibanstringOptional

The IBAN of the bank account, up to 34 characters. Required if the account currency is EUR. Monite verifies the IBAN length, checksum digits, and country-specific format according to ISO 13616.

is_default_for_currencybooleanOptionalDefaults to false

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.

routing_numberstringOptional

The bank’s routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits.

sort_codestringOptional
The bank's sort code. Required if the account currency is GBP.

Response

Successful Response
idstringformat: "uuid"
Unique ID of the bank account.
account_holder_namestring or null
The name of the person or business that owns this bank account. Required in the following cases: * the account currency is GBP or USD, * the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account.
account_numberstring or null
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.
account_number_last4string or null
The last 4 digits of bank account number. Required if the account currency is GBP or USD and there is no information about the full account number.
bank_namestring or null
The bank name.
bicstring or null

The SWIFT/BIC code of the bank. Can be either 8 or 11 characters long. Monite verifies the BIC length, country code, and whether the structure conforms to ISO 9362.

If bic is specified, iban must also be specified.

countryenum or null
The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
currencyenum or null

The currency of the bank account, represented as a three-letter ISO currency code.

display_namestring or null

User-defined name of this bank account, such as ‘Primary account’ or ‘Savings account’.

ibanstring or null

The IBAN of the bank account, up to 34 characters. Required if the account currency is EUR. Monite verifies the IBAN length, checksum digits, and country-specific format according to ISO 13616.

is_default_for_currencyboolean or nullDefaults to false
Indicates whether this bank account is the default one for its currency.
routing_numberstring or null

The bank’s routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits.

sort_codestring or null
The bank's sort code. Required if the account currency is GBP.
was_created_by_user_idstring or nullformat: "uuid"

ID of the entity user who added this bank account, or null if it was added using a partner access token.

Errors