Manage bank accounts

Overview

Entities that represent the customers of Monite API partners can have their bank account information associated with them. These bank accounts can be set as default for payment in different currencies.

Add a bank account to an entity

Entities can have bank account information associated with them. To add a bank account to an entity, call POST /bank_accounts passing the entity ID in the header:

curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \
     -H 'X-Monite-Version: 2023-03-14' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "iban": "GB33BUKB20201555555555",
       "bic": "GB33BUKB202",
       "bank_name": "Bank",
       "display_name": "Bank",
       "is_default": false,
       "account_holder_name": "Mary O Brien",
       "account_number": "123456789",
       "routing_number": null,
       "sort_code": null,
       "currency": "EUR",
       "country": "DE"
     }'

The successful response returns the information about the newly added bank account:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "iban": "GB33BUKB20201555555555",
  "bic": "GB33BUKB202",
  "bank_name": "Bank",
  "display_name": "Bank",
  "is_default": false,
  "was_created_by_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_holder_name": "Mary O Brien",
  "account_number": "123456789",
  "routing_number": null,
  "sort_code": null,
  "currency": "EUR",
  "country": "DE"
}

The fields expected as mandatory are based on the country of the bank.

For UK Banks:

account_number
sort_code
currency
country

For EU Banks

IBAN
currency
country

Set the default bank account

Once the bank accounts are added to the entity, set a default bank account for each currency by calling POST /bank_accounts/{bank_account_id}/make_default:

curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts/3fa8...f66afa6/make_default' \
     -H 'X-Monite-Version: 2023-03-14' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d ''

The successful response contains information about the bank account marked as default:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "iban": "GB33BUKB20201555555555",
  "bic": "GB33BUKB202",
  "bank_name": "Bank name",
  "is_default": true,
  "display_name": "My main account",
  "was_created_by_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_holder_name": "Mary O Brien",
  "account_number": "123456789",
  "routing_number": null,
  "sort_code": null,
  "currency": "EUR",
  "country": "DE"
}

The default bank account is set for each currency. Only one default bank account per currency is allowed.

If a new bank account is added to a currency with no default bank account set, the newly added bank account is automatically set as the default for that currency.

List all bank accounts

To get information about all bank accounts associated with the specified entity, call GET /bank_accounts.

Retrieve a bank account

To get information about a specific bank account associated with the specified entity, call GET /bank_accounts/{entity_bank_account_id}.

Edit a bank account

To edit an existing bank account of the specified entity, call PATCH /bank_accounts/{entity_bank_account_id}.

Delete a bank account

To delete an existing bank account from the list of bank accounts associated with the specified entity, call DELETE /bank_accounts/{entity_bank_account_id}.