⚠️
Deprecated
The counterparty object and related API endpoints are deprecated and will be removed and should no longer be used.

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

Attribute	Description
id string	The counterparty ID.
object string	Always `counterparty`.
name string	The counterparty name.
counterparty_accounts array	The counterparty accounts linked to the counterparty. See Counterparty accounts.
virtual_accounts array	The virtual accounts linked to the counterparty. See Virtual accounts.
metadata object	Additional data in JSON `key:value` format. See Metadata.
disabled_at datetime	The counterparty disabling UTC timestamp.
created_at datetime	The counterparty creation UTC timestamp.

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",
         "status": "approved",
         "status_details": "",
         "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": "2023-11-17T09:53:19.734182Z",
         "disabled_at": null
      },
      {
         "id": "67bc70b0-2aab-11ed-a261-0242ac120002",
         "counterparty_account_number": "FR7017569000308578945623E73",
         "bank_code": "SOGEFRPP",
         "status": "denied",
         "status_details": "The account information is outdated",
         "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": "2023-11-03T11:51:20.734182Z",
         "disabled_at": ""
      }
   ],
   "virtual_accounts": [
      {
         "id": "61074e4c-ec78-4569-921a-496051dd5882",
         "connected_account_id": "70f71ada-8b87-11ed-a1eb-0242ac120002 ",
         "name": "PartnerCo",
         "virtual_account_number": "FR4814508000403421616958R20",
         "created_at": "2023-01-07T13:51:00.62588Z",
         "disabled_at": null
      }
   ],
   "metadata": {},
   "disabled_at": null,
   "created_at": "2023-01-03T08:12:11.734182Z"
}