A virtual account is a unique account number linked to a main bank account. It can be assigned to counterparties and expected payments to facilitate the identification of payments received, as part of a manual or automated reconciliation.
| Attribute | Description |
|---|---|
| id string | The virtual account ID. |
| object string | Always virtual_account. |
| name string | The virtual account name. |
| virtual_account_number string | The virtual account number. |
| connected_account_id string | The ID of the connected account linked to the virtual account. |
| counterparty_id string | The ID of the counterparty to linked to the virtual account. |
| metadata object | Additional data in JSON key:value format. See Metadata. |
| disabled_at datetime | The virtual account disabling UTC timestamp. |
| created_at datetime | The virtual account creation UTC timestamp. |
Below is an example of a virtual account:
{
"id": "6abc3626-e17f-11ec-8fea-0242ac120002",
"object": "virtual_account",
"connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
"name": "PartnerCo",
"virtual_account_number": "FR8912739000502336592595G08",
"counterparty_id": "b69837bf-e784-4bd1-b0d0-2ad0e61a89b6",
"metadata": {},
"disabled_at": null,
"created_at": "2022-10-03T17:53:20.734182Z"
}