A counterparty account is the bank account of a counterparty. It has all the account details required to send a payment to this counterparty.
| Attribute | Description |
|---|---|
| id string | The UUID of the counterparty account. |
| object string | The object, here counterparty_account. |
| holder_name string | The legal entity or individual name of the counterparty account. |
| account_number string | The account number of the counterparty account. For example, the IBAN. In case account_number is an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder. |
| bank_code string | The bank code of the counterparty account. For example, the BIC. |
| holder_address string | The holder address of the counterparty account. See address object. |
| counterparty_id string | The ID of the counterparty to which the counterparty account refers to. |
| metadata object | Additional data in JSON key:value format. See Metadata. |
| disabled_at datetime | The UTC timestamp of the disabling of this counterparty account. |
| created_at datetime | The UTC timestamp of the creation of this counterparty account. |
Below is an example of a counterparty account:
{
"id": "b38f5318-a389-4278-9cbe-d16116750982",
"object": "counterparty_account",
"holder_name": "PartnerCo",
"holder_address": {
"country": "FR",
"line_1": "1, rue de la Bourse",
"line_2": "",
"postal_code": "59000",
"region_state": "",
"city": "Lille"
},
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"counterparty_id": "c3fd9ee4-2aab-11ed-a261-0242ac120002",
"metadata": {},
"disabled_at": null,
"created_at": "2022-01-03T09:53:19.734182Z",
}