External Accounts

Create a new external account

Create a new external account. This external account will be usable for credit within a transfer.

Request body

accountIdstring required

Identifier of the account

labelstring required

Label of the account.

accountNumberstring required

Number of the account.

ibanstring

ISO 13616 format for a bank account.

status'DELETED' | 'ACTIVATION_IN_PROGRESS' | 'ACTIVATED' required

Status of the external account (beneficiary). <table><tr><td>Code</td> <td>Meaning</td></tr><tr><td>DELETED</td> <td>The external account has been canceled. It will not be usable anymore.</td></tr><tr><td>ACTIVATION_IN_PROGRESS</td> <td>The external account has been created but is not usable yet.</td></tr><tr><td>ACTIVATED</td> <td>The external account can be used for a new transfer.</td></tr></table>

activationDateTimestring date-time

If the beneficiary account is being activated, indicates the date from which it will be usable.

isHolderboolean

Indicates whether the subscriber is the owner or co-owner of the beneficiary account. Declarative data.

groupLabelsstring[]

Name of the beneficiary groups to which the account is attached.

Example request

{
  "accountId": "13807-1-CPT31719694553",
  "label": "DUPONT JEAN",
  "accountNumber": "31719694553",
  "iban": "FR7613807000343179999999943",
  "financialInstitution": {
    "id": "1-CCBPFRPPNAN",
    "label": "BANQUE POPULAIRE GRAND OUEST",
    "identifiers": [
      {
        "value": "CCBPFRPPNAN",
        "type": "BIC"
      }
    ]
  },
  "currencies": [
    {
      "code": "EUR",
      "label": "Euro"
    }
  ],
  "status": "ACTIVATED"
}

Response

The external account is created and may be activated.