Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Counterparties

Create counterparty

Create a counterparty. Once created, you can create related counterparty accounts.

post/counterparties

Request body

namestring required

The name of the counterparty.

metadataobject

Additional client data in JSON format. See Metadata.

Example request

{
  "name": "PartnerCo SAS",
  "metadata": {
    "property_a": true,
    "property_b": "some text"
  }
}

Response

200

idstring uuid required

The UUID of the counterparty.

namestring required

The name of the counterparty

objectstring required

Type of the object, counterparty.

created_atstring date-time required

The UTC timestamp of the creation of this counterparty.

disabled_atstring date-time

The UTC timestamp of the disabling of this counterparty.

metadataobject

Additional client data in JSON format. See Metadata.

Example response

{
  "name": "MyCounterparty",
  "object": "counterparty",
  "counterparty_accounts": [
    {
      "holder_name": "Joe Black",
      "account_number": "FR1420041010050500013M02606",
      "bank_code": "BNPAFRPPXXX",
      "holder_address": {
        "line_1": "1, rue de la Bourse",
        "building_number": "1",
        "street_name": "rue de la Bourse",
        "postal_code": "59000",
        "city": "Lille",
        "country": "FR"
      }
    }
  ],
  "metadata": {
    "property_a": true,
    "property_b": "some text"
  }
}