The counterparty object

A counterparty is an individual or organization you need to send money to or receive money from.

AttributeDescription
id
string		The UUID of the counterparty.
object
string		The object, here counterparty.
name
string		The name of the counterparty.
counterparty_accounts
array		The counterparty accounts related to the counterparty. See Counterparty Account.
virtual_accounts
array		The virtual accounts related to the counterparty. See Virtual Account.
metadata
object		Additional data in JSON key:value format. See Metadata.
disabled_at
datetime		The UTC timestamp of the disabling of this counterparty.
created_at
datetime		The UTC timestamp of the creation of this counterparty.

Below is an example of a counterparty :

{
    "id": "c3fd9ee4-2aab-11ed-a261-0242ac120002",
    "object": "counterparty",
    "name": "PartnerCo",
    "counterparty_accounts": [
        {
            "id": "b38f5318-a389-4278-9cbe-d16116750982",
            "counterparty_account_number": "FR7601234567891127967100082",
            "bank_code": "BNPAFRPPXXX",
            "holder_name": "PartnerCo",
            "holder_address": {
                "line_1": "1, rue de la Bourse",
                "line_2": "",
                "postal_code": "59000",
                "region_state": "",
                "city": "Lille",
                "country": "FR"
            },
            "created_at": "2022-01-03T09:53:19.734182Z",
            "disabled_at": null
        },
        {
            "id": "67bc70b0-2aab-11ed-a261-0242ac120002",
            "counterparty_account_number": "FR7017569000308578945623E73",
            "bank_code": "SOGEFRPP",
            "holder_name": "PartnerCo",
            "holder_address": {
                "line_1": "1, rue de la Paix",
                "line_2": "",
                "postal_code": "75001",
                "region_state": "",
                "city": "Paris",
                "country": "FR"
            },
            "created_at": "2022-01-03T11:51:20.734182Z",
            "disabled_at": "2022-01-05T12:00:49.734182Z"
        }
    ],
    "virtual_accounts": [
        {
            "id": "61074e4c-ec78-4569-921a-496051dd5882",
            "connected_account_id": "70f71ada-8b87-11ed-a1eb-0242ac120002 ",
            "name": "PartnerCo",
            "virtual_account_number": "FR4814508000403421616958R20",
            "created_at": "2022-01-07T13:51:00.62588Z",
            "disabled_at": null
        },
    ],
    "metadata": {},
    "disabled_at": null,
    "created_at": "2022-01-03T08:12:11.734182Z",
}