CommonEntity bank accounts

Set an entity’s bank account as the default for its currency

Set a bank account as the default for this entity per currency.

Path parameters

bank_account_idstringRequired

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.

Response

Successful Response

idstringformat: "uuid"

Unique ID of the bank account.

account_holder_namestringOptional

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.

countryenumOptional

The country in which the bank account is registered, repsesented as a two-letter country code (ISO 3166-1 alpha-2).

currencyenumOptional

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

display_namestringOptional

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

Indicates whether this bank account is 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.

was_created_by_user_idstringOptionalformat: "uuid"

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

Errors