v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

connected-accounts

List connected accounts

List and filter connected accounts.

get/connected_accounts

Query parameters

limitinteger

starting_afterstring

Example:b5ae8f5c-8500-4541-be19-3f38471fabcf

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

Example:2022-06-17

end_datestring date

Example:2022-06-17

enabledboolean

true: search for connected_accounts which are explicitly enabled
false: search for connected_accounts which are explicitly disabled
Not provided: search for all connected_accounts no matter they are enabled or disabled

bank_namestring

Example:BNP Paribas

The bank name of the connected account.

address.countrystring

Example:FR

The country of the connected account's address (as ISO 3166 alpha-2 country code).

Response

List of filtered connected accounts.

Example response

{
  "records": [
    {
      "id": "634f662d-44f3-4b56-b823-a1442d5beb69",
      "object": "connected_account",
      "type": "corporate",
      "name": "BNP Paribas TechCo account",
      "bank_code": "BNPAFRPPXXX",
      "bank_name": "BNP Paribas",
      "bank_address": {
        "line_1": "1, avenue des Champs Elysées",
        "line_2": "75008 Paris, France",
        "building_number": "1",
        "street_name": "avenue des Champs Elysées",
        "postal_code": "75008",
        "region_state": "Ile de France",
        "city": "Paris",
        "country": "FR",
        "room": "47",
        "floor": "3",
        "postal_box": "67b",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "district_name": "District 9",
        "city_location_name": "Confluences"
      },
      "creditor_identifier": "FR12ZZZ123456",
      "legal_entity_identifier": "529900T8BM49AURSDO55",
      "currency": "EUR",
      "account_number": "FR1420041010050500013M02606",
      "account_number_format": "iban",
      "bank_code_format": "bic",
      "address": {
        "line_1": "1, avenue des Champs Elysées",
        "line_2": "75008 Paris, France",
        "building_number": "1",
        "street_name": "avenue des Champs Elysées",
        "postal_code": "75008",
        "region_state": "Ile de France",
        "city": "Paris",
        "country": "FR",
        "room": "47",
        "floor": "3",
        "postal_box": "67b",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "district_name": "District 9",
        "city_location_name": "Confluences"
      },
      "metadata": {
        "key_one": "value",
        "key_two": 24
      },
      "bank_data": {
        "external_id": "1234567890"
      }
    }
  ]
}