v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Internal Accounts

List internal accounts

List and filter internal accounts.

get/internal_accounts

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the internal account.

end_datestring date

The creation date of the internal account.

connected_account_idstring uuid

The ID of the connected account to which the virtual account refers.

namestring

The name of the internal account.

type'own' | 'virtual'

The type of the internal account.

account_numberstring

The account number of the internal account.

bank_codestring

The bank code of the internal account.

creditor_identifierstring

The creditor identifier of the internal account.

account_holder_idstring uuid

The ID of the account holder to which the internal account refers to.

holder_namestring

The account holder name to look for. Searches through the holder_name and alternative_holder_names attributes.

status'active' | 'blocked' | 'disabled'

If disabled, only disabled internal accounts will be fetched.

Response

200

Example response

{
  "records": [
    {
      "organization_identification": {
        "legal_entity_identifier": "529900T8BM49AURSDO55",
        "business_identification_code": "SOMEBIC0XXX",
        "default_other_identifier_type": "siren",
        "others": [
          {
            "type": "siren",
            "value": "901250746"
          }
        ]
      },
      "holder_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      },
      "bank_name": "BankCo",
      "bank_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      },
      "creditor_identifier": "FR12ZZZ123456",
      "bank_data": {
        "message_id": "1gXrtKMxLJ",
        "file_id": "4f5ab48b-9693-4292-86f6-1c2fe347d061"
      },
      "metadata": {
        "property_a": true,
        "property_b": "some text"
      },
      "cbs_account_id": "ACC-ID-CBS-0000-0000",
      "currencies": [
        "EUR",
        "USD"
      ],
      "customer_bic": "BNPAFRPPXXX",
      "distinguished_name": "CN=foo,OU=bar,O=baz"
    }
  ]
}