HomeGuidesRecipesAPI ExplorerForumSupport
Partner Portal
Partner Portal

Manage bank accounts

Learn how to manage the counterpart's bank accounts.

Overview

Counterparts that represent an entity's vendors or suppliers can have bank account information associated with them. The bank account information can be used to pay the invoices (payables) issued by those counterparts.

Add a bank account to a counterpart

To add a bank account to a counterpart, call POST /counterparts/{counterpart_id}/bank_accounts and provide the bank account details.

All bank accounts require the currency and country. Other necessary fields depend on the country and the type of fund transfers - domestic or international.

International
transfers
EU banksUK banksUS banks
- iban
- bic
- iban
- bic
- account_number
- sort_code
- iban (optional)
- bic (optional)
- account_holder_name
- account_number
- routing_number
- bic (optional)

Sample requests:

curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/3a9c5...8df/bank_accounts' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "iban": "DE74500700100100000900",
       "bic": "DEUTDEFFXXX",
       "account_holder_name": "Tobias Weingart",
       "name": "Primary account",
       "currency": "EUR",
       "country": "DE",
       "is_default_for_currency": false
     }'
curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/3a9c5...8df/bank_accounts' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "iban": "GB15HBUK40312412345678",
       "bic": "HBUKGB4B",
       "account_number": "12345678",
       "sort_code": "403124",
       "account_holder_name": "Esther Walsh",
       "name": "Primary account",
       "currency": "GBP",
       "country": "GB",
       "is_default": true
     }'
curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/3a9c5...8df/bank_accounts' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "account_number": "2571714302",
       "routing_number": "061000227",
       "account_holder_name": "Bob Jones",
       "name": "Primary account",
       "currency": "USD",
       "country": "US",
       "is_default": true
     }'

The successful response returns the id assigned to this bank account, along with other details:

{
  "id": "04476eb4-121e-44dd-8a0d-1bcaa9246265",
  "counterpart_id": "3a9c5924-2c3f-47af-905a-e4c7efe548df",
  "is_default_for_currency": false,
  "partner_metadata": {},
  ...
}

Set the default bank account

Once the bank accounts are added to a counterpart, you can set a default bank account for each currency by making a POST request to the /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/make_default endpoint:

curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/make_default' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN'

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "iban": "GB33BUKB20201555555555",
  "bic": "GB33BUKB202",
  "bank_name": "Bank name",
  "is_default_for_currency": 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 counterpart bank account is set for each currency. Each counterpart can only have one default bank account per currency. The is_default_for_currency field shows which counterparts' bank accounts are the default for each currency.

If a new counterpart 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 counterpart, call
GET /counterparts/{counterpart_id}/bank_accounts.

Retrieve a bank account

To get information about a specific bank account associated with the specified counterpart, call
GET /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}.

Edit a bank account

To edit an existing bank account of the specified counterpart, call
PATCH /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}.

Delete a bank account

To delete an existing bank account from the list of bank accounts associated with the specified counterpart, call
/counterparts/{counterpart_id}/bank_accounts/{bank_account_id}. Only non-default bank accounts can be deleted.