Update an entity's bank account

PATCH
/bank_accounts/:bank_account_id

Change the specified fields with the provided values.

Path parameters

bank_account_idstringRequired

Headers

Auth
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.
account_holder_namestringOptional=1 character

The name of the person or business that owns this bank account. If the account currency is GBP or USD, the holder name cannot be changed to an empty string.

display_namestringOptional=1 character

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

Response

Successful Response

idstring

Unique ID of the bank account.

account_holder_namestringOptional

The name of the person or business that owns this bank account. Required if the account currency is GBP or USD.

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.

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. Required if the account currency is EUR.

is_default_for_currencybooleanOptional

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_idstringOptional

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

Errors