HomeGuidesRecipesAPI ExplorerForumSandboxSupport

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 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:

curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/{counterpart_id}/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": "GB33BUKB20201555555555",
       "bic": "GB33BUKB202",
       "name": "Personal account",
       "account_holder_name": "Mary O Brien",
       "account_number": "123456789",
       "sort_code": null,
       "routing_number": null,
       "currency": "EUR",
       "country": "DE",
       "is_default": false
     }'

The successful response returns the information about the bank account:

{
  "iban": "GB33BUKB20201555555555",
  "bic": "GB33BUKB202",
  "name": "Personal account",
  "account_holder_name": "Mary O Brien",
  "account_number": "123456789",
  "sort_code": null,
  "routing_number": null,
  "currency": "EUR",
  "country": "DE",
  "is_default": false,
  "id": "04476eb4-121e-44dd-8a0d-1bcaa9246265",
  "counterpart_id": "3a9c5924-2c3f-47af-905a-e4c7efe548df"
}

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.