A connected account is a bank account managed through Numeral.
| Attribute | Description |
|---|---|
| id string | The ID of the connected account. |
| type string | The type of the connected account, either financial_institution or corporate. |
| name string | The name of the connected account. |
| bic (deprecated) string | The BIC of the connected account. It has been deprecated in favour of bank_code. |
| bank_code string | The bank code of the connected account. It can be a BIC or a sort code. |
| account_number string | The account number of the connected account. |
| creditor_identifier string | The unique reference for organisations collecting payments by SEPA Direct Debit. |
| services_activated array[string] | The services activated for the connected account. |
| file_auto_approval boolean | Either true or false, default value is false. When file_auto_approval is true, every outgoing files generated from this connected account get automatically approved. When file_auto_approval is false, the payment and return outgoing files generated from this connected account remain in status created until they get approved. |
| metadata object | Additional data in JSON format. See Metadata. |
| disabled_at nullable datetime | The UTC timestamp at which this connected account has been disabled. |
| created_at datetime | The UTC timestamp of the creation of this connected account. |
Below is an example of a connected_account:
{
"id": "634f662d-44f3-4b56-b823-a1442d5beb69",
"type": "corporate",
"name": "BNP Paribas TechCo account",
"bank_code": "BNPAFRPPXXX",
"bic": "BNPAFRPPXXX",
"creditor_identifier": "FR12ZZZ123456",
"account_number": "FR1420041010050500013M02606",
"services_activated": ["sct"],
"file_auto_approval": true,
"disabled_at": null,
"created_at": "2022-06-19T23:19:06.447Z"
}