Manage bank accounts
Learn how to manage the entities' 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
To add a bank account to an entity, call POST /bank_accounts
and provide the bank account details. All bank accounts require the currency
and country
. Other required fields depend on the country:
EU banks | UK banks | US banks |
---|---|---|
- iban | - account_number - sort_code | - account_number - routing_number |
Sample request:
curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \
-H 'X-Monite-Version: 2023-06-04' \
-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": true,
"account_holder_name": "Tobias Weingart",
"currency": "EUR",
"country": "DE"
}'
curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \
-H 'X-Monite-Version: 2023-06-04' \
-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": true,
"account_holder_name": "Esther Walsh",
"account_number": "12345678",
"sort_code": 403124,
"currency": "GBP",
"country": "GB"
}'
curl -X POST 'https://api.sandbox.monite.com/v1/bank_accounts' \
-H 'X-Monite-Version: 2023-06-04' \
-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": 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:
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"was_created_by_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
...
}
Set the default bank account
Once the bank accounts are added to the entity, set the 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-06-04' \
-H 'X-Monite-Entity-Id: ENTITY_ID' \
-H 'Authorization: Bearer ACCESS_TOKEN'
The successful response contains information about the entity 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"
}
Notes
- 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.
- If an entity wants to make and receive payments using the
sepa_credit
payment method, its default bank account must be in a country in the Single Euro Payments Area (SEPA).
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}
.
Updated 25 days ago