v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

connected-accounts

Retrieve connected account

Retrieve the details of a connected account.

get/connected_accounts/{id}

Path parameters

idstring required

Example:634f662d-44f3-4b56-b823-a1442d5beb69

The ID of the connected account being looked for.

Response

Successfully retrieved connected account.

idstring required

The ID of the connected account.

objectstring required

Type of the object, connected_account.

type'financial_institution' | 'corporate' required

The type of the connected account: * financial_institution: * corporate:

namestring required

The name of the connected account.

bank_codestring required

The bank code of the connected account. It can be a BIC or a sort code.

bank_namestring required

Name of the bank to which this connected_account is linked.

creditor_identifierstring required

The unique reference for organisations collecting payments by SEPA Direct Debit.

legal_entity_identifierstring

The legal entity identifier (LEI) of the connected account.

currencystring iso-4217 required

The currency of the connected account, as an ISO 4217 currency code.

account_numberstring required

The account number of the connected account.

account_number_format'iban' | 'uk_account_number' | 'us_account_number' | 'tokenized' | 'other'

The format of the account number.

bank_code_format'bic' | 'uk_sorting_code' | 'us_aba_routing_number' | 'tokenized' | 'other'

The format of the bank code.

services_activatedConnectedAccountBankService[] required

The services activated for the connected account.

file_auto_approvalboolean required

When file_auto_approval is true, files related to this connected account get automatically approved. When file_auto_approval is false, files related to this connected account must be approved in order to be sent.

metadataobject required

Additional client data in JSON format. See Metadata.

custom_fieldsCommonCustomFields required

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

disabled_atstring date-time nullable required

created_atstring date-time required

2022-06-17T08:49:54.54422Z

Example response

{
  "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"
  }
}