Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Counterparty Accounts

Retrieve counterparty account

Retrieve the details of a counterparty account.

get/counterparty_accounts/{id}

Path parameters

idstring required

The ID of the counterparty account.

Response

200

idstring uuid required

The UUID of the counterparty account.

objectstring required

Type of the object, counterparty_account.

type'individual' | 'legal_entity'

The type of the counterparty account.

namestring

The name of the counterparty account.

holder_namestring required

The name of the legal entity or individual holding the account.

account_numberstring required

The account number.

counterparty_idstring required

The ID of the related counterparty.

company_registration_numberstring

The company registration number of the counterparty account, when type = legal_entity.

company_registration_number_type'eu_vat' | 'fr_siren' | 'fr_siret' | 'nl_kvk' | 'nl_kvk_branch' | 'other' | 'uk_crn'

The type of the counterparty account's company registration number, when type = legal_entity.

bank_codestring required

The bank code, for instance BIC / Swift code, UK sort code, or US routing number.

status'pending_approval' | 'approved' | 'denied' | 'disabled' required

The status of this counterparty account.

status_detailsstring required

The details of the status of this counterparty account.

created_atstring date-time required

The UTC timestamp of the creation of this counterparty account.

disabled_atstring date-time

The UTC timestamp of the disabling of this counterparty account.

metadataobject

Additional client data in JSON format. See Metadata.

custom_fieldsCommonCustomFields required

Custom fields in JSON key:value format. See Custom fields.

Example response

{
  "object": "counterparty_account",
  "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"
  },
  "account_verification": {
    "result": "valid",
    "valid_account_number": {
      "result": "valid",
      "details": {
        "reason": "unauthorized_characters",
        "expected_value": "SOMEBIC0XXX",
        "message": "IBAN contains unauthorized characters"
      }
    },
    "matching_account_number_and_bank_code": {
      "result": "valid",
      "details": {
        "reason": "unauthorized_characters",
        "expected_value": "SOMEBIC0XXX",
        "message": "IBAN contains unauthorized characters"
      }
    },
    "matching_account_holder": {
      "result": "valid",
      "details": {
        "reason": "unauthorized_characters",
        "expected_value": "SOMEBIC0XXX",
        "message": "IBAN contains unauthorized characters"
      }
    },
    "active_account": {
      "result": "valid",
      "details": {
        "reason": "unauthorized_characters",
        "expected_value": "SOMEBIC0XXX",
        "message": "IBAN contains unauthorized characters"
      }
    }
  },
  "metadata": {
    "property_a": true,
    "property_b": "some text"
  }
}