> This page is for version v2023-09-01. > For other versions, use one of these documentation indexes: > - v2024-05-25 (default): https://docs.monite.com/v-2024-05-25/llms.txt > - v2024-01-31: https://docs.monite.com/v2024-01-31/llms.txt > - v2023-09-01: https://docs.monite.com/v2023-09-01/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.monite.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.monite.com/_mcp/server. # Entity bank accounts ## Overview Entities that represent the customers of Monite [partners](../references/glossary#partner) 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 To add a bank account to an entity, call [`POST /bank_accounts`](/v2023-09-01/api/entity-bank-accounts/post-bank-accounts) and provide the bank account details. All bank accounts require the `country` and `currency`. In most cases, bank accounts must be located in the country where the currency is the official currency. For example: * USD can only be chosen for bank accounts in the US. * GBP can only be chosen for bank accounts in the UK (including Gibraltar). * EUR can only be chosen for bank accounts in the EU, Liechtenstein, Norway, Switzerland, and UK (including Gibraltar). Other required fields in bank accounts depend on the currency:
EUR accounts GBP accounts USD accounts Other currencies
`iban` `country` = "UK" or "GI" `account_holder_name` `account_number` `sort_code` `country` = "US" `account_holder_name` `account_number` `routing_number` One of: * `iban` * `account_number` and `sort_code` * `account_number` and `routing_number`
\ Sample request: #### EUR bank account ```sh curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \ -H 'X-Monite-Version: 2023-09-01' \ -H 'X-Monite-Entity-Id: ENTITY_ID' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "iban": "DE74500700100100000900", "bic": "DEUTDEFFXXX", "bank_name": "DEUTSCHE BANK AG", "display_name": "Primary account", "is_default_for_currency": true, "account_holder_name": "Tobias Weingart", "currency": "EUR", "country": "DE" }' ``` #### GBP bank account ```sh curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \ -H 'X-Monite-Version: 2023-09-01' \ -H 'X-Monite-Entity-Id: ENTITY_ID' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "iban": "GB15HBUK40312412345678", "bic": "HBUKGB4B", "bank_name": "HSBC UK BANK PLC", "display_name": "Primary account", "is_default_for_currency": true, "account_holder_name": "Esther Walsh", "account_number": "12345678", "sort_code": 403124, "currency": "GBP", "country": "GB" }' ``` #### USD bank account ```sh curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \ -H 'X-Monite-Version: 2023-09-01' \ -H 'X-Monite-Entity-Id: ENTITY_ID' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "bank_name": "WELLS FARGO", "display_name": "Primary account", "is_default_for_currency": true, "account_holder_name": "Bob Jones", "account_number": "2571714302", "routing_number": "061000227", "currency": "USD", "country": "US" }' ``` The successful response returns the unique `id` assigned to the added bank account, along with other details: ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "was_created_by_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... } ``` ## Set the default bank account \[#default] 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`](/v2023-09-01/api/entity-bank-accounts/post-bank-accounts-id-make-default): ```sh curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts/3fa8...f66afa6/make_default' \ -H 'X-Monite-Version: 2023-09-01' \ -H 'X-Monite-Entity-Id: ENTITY_ID' \ -H 'Authorization: Bearer ACCESS_TOKEN' ``` > **Info** > > The default entity 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. ## Verify a bank account Bank account verification uses open banking to confirm that entity bank account details are accurate and that the account holder matches the provided information. Verification is required for certain payment methods, particularly SEPA credit transfers through payment links. To initiate verification for an entity bank account, call `POST /bank_accounts/{bank_account_id}/verify`: ```sh curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts/{bank_account_id}/verify' \ -H 'X-Monite-Version: 2023-09-01' \ -H 'X-Monite-Entity-Id: ENTITY_ID' \ -H 'Authorization: Bearer ACCESS_TOKEN' ``` The verification process uses open banking to validate bank account details. The response confirms the verification request was initiated: ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "iban": "DE89370400440532013000", "bic": "COBADEFFXXX", "account_holder_name": "Andreas Weingart", "currency": "EUR", "country": "DE", "is_default_for_currency": true, "open_banking_verification_status": "pending", "open_banking_verification_error": null } ``` The `open_banking_verification_status` field indicates the current verification state: * `not_verified` - Verification has not been initiated (default) * `pending` - Verification is in progress * `verified` - Bank account successfully verified * `failed` - Verification failed * `expired` - Verification expired and must be restarted * `not_applicable` - Verification is not applicable for this bank account When verification fails, `open_banking_verification_error` contains a string with details about the failure reason. This field is `null` when verification succeeds or has not been attempted. The error message is reset after a successful verification. Here is an xample response with verification error: ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "iban": "DE89370400440532013000", "open_banking_verification_status": "failed", "open_banking_verification_error": "Account holder name mismatch" } ``` Here are the possible error messages: * **"IBAN doesn't match name"** - The account holder name does not match the IBAN * **"IBAN doesn't match name. Did you mean `closeMatchName`?"** - Close match found, suggesting a similar name * **"Unknown beneficiary"** - The beneficiary account does not exist in the banking system ## List all bank accounts To get information about all bank accounts associated with the specified entity, call [`GET /bank_accounts`](/v2023-09-01/api/entity-bank-accounts/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}`](/v2023-09-01/api/entity-bank-accounts/get-bank-accounts-id). ## Edit a bank account You can update the `account_holder_name` and `display_name` of existing entity bank accounts. To do this, call [`PATCH /bank_accounts/{entity_bank_account_id}`](/v2023-09-01/api/entity-bank-accounts/patch-bank-accounts-id) and provide the new values. To update other bank account details (for example, `iban`), you will need to delete the existing bank account and create a new one instead. > **Info** > > The `account_holder_name` of existing GBP and USD bank accounts cannot be changed to an empty string since it is a required field. ## 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}`](/v2023-09-01/api/entity-bank-accounts/delete-bank-accounts-id).