A connected account represents the connectivity between a Numeral customer and its partner bank. It can be a bank account holding transactions and balances or a technical account used for bank or payment scheme connectivity-purposes only.
Attribute | Description |
---|---|
id string | The ID of the connected account. |
object string | Always connected_account . |
type string | The type of the connected account. One of financial_institution or corporate . |
name string | The label of the connected account. |
account_number string | The IBAN or account number of the account. |
bank_code string | The BIC / Swift code or sort code of the account, depending on the country and bank. Only upper case letters allowed. |
bank_name string | The name of the bank connected_account holding the account. |
address object | The account holder address, as an address object. |
creditor_identifier string | The unique reference for creditors collecting payments through direct debit, either SCI for SEPA or SUN for Bacs. |
currency string | The currency of the connected account, as an ISO 4217 currency code. |
services_activated array[string] | The services (payment methods, reporting services, payment features…) activated for the connected account. |
file_auto_approval boolean | Set to false by default. Set to true to automatically approve payment files. |
metadata object | Additional data in JSON format. See Metadata. |
disabled_at nullable datetime | The UTC timestamp of the disabling of the connected account. |
created_at datetime | The UTC timestamp of the creation of the connected account. |
Below is an example of a connected account:
{
"id": "634f662d-44f3-4b56-b823-a1442d5beb69",
"object": "connected_account",
"type": "corporate",
"name": "BNP Paribas TechCo account",
"bank_code": "BNPAFRPPXXX",
"bank_name": "BNP Paribas",
"creditor_identifier": "FR12ZZZ123456",
"currency": "EUR",
"account_number": "FR1420041010050500013M02606",
"services_activated": [
"sct",
"sct_inst",
"sdd"
],
"file_auto_approval": true,
"address": {
"line_1": "",
"line_2": "",
"building_number": "1",
"street_name": "avenue des Champs Elysées",
"postal_code": "75008",
"region_state": "Ile de France",
"city": "Paris",
"country": "FR"
},
"disabled_at": null,
"created_at": "2022-06-19T23:19:06.447Z"
}