Counterpart 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.

Sample requests:

1
curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/3a9c5...8df/bank_accounts' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
4
     -H 'Authorization: Bearer ACCESS_TOKEN' \
5
     -H 'Content-Type: application/json' \
6
     -d '{
7
       "iban": "DE74500700100100000900",
8
       "bic": "DEUTDEFFXXX",
9
       "account_holder_name": "Tobias Weingart",
10
       "name": "Primary account",
11
       "currency": "EUR",
12
       "country": "DE",
13
       "is_default_for_currency": false
14
     }'

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

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

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:

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

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

1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "iban": "GB33BUKB20201555555555",
4
  "bic": "GB33BUKB202",
5
  "bank_name": "Bank name",
6
  "is_default_for_currency": true,
7
  "display_name": "My main account",
8
  "was_created_by_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9
  "account_holder_name": "Mary O Brien",
10
  "account_number": "123456789",
11
  "routing_number": null,
12
  "sort_code": null,
13
  "currency": "EUR",
14
  "country": "DE"
15
}

Verify a counterpart 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 a counterpart bank account, call POST /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/verify:

1
curl -X POST 'https://api.sandbox.monite.com/v1/counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/verify' \
2
  -H 'X-Monite-Version: 2024-05-25' \
3
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
4
  -H 'x-monite-entity-id: ENTITY_ID'

The verification process uses open banking to validate the bank account details. The response confirms the verification request was initiated:

1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "iban": "DE89370400440532013000",
4
  "bic": "COBADEFFXXX",
5
  "account_holder_name": "Mary O Brien",
6
  "currency": "EUR",
7
  "country": "DE",
8
  "is_default_for_currency": true,
9
  "open_banking_verification_status": "pending",
10
  "open_banking_verification_error": null
11
}

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 example response with verification error:

1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "iban": "DE89370400440532013000",
4
  "open_banking_verification_status": "failed",
5
  "open_banking_verification_error": "Account holder name mismatch"
6
}

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