v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Internal Accounts

Update an internal account

Update the attributes of an internal account.

post/internal_accounts/{id}

Request body

namestring

The name of the internal account.

holder_namestring

The name of the internal account holder.

alternative_holder_namesstring[]

Alternative account holder names, for instance if the account is a joint account.

custom_fieldsCommonCustomFields

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

currenciesstring[]

ISO 4217 currencies of the account.

customer_bicstring

BIC of the internal account. Used for Swift correspondent payments.

distinguished_namestring

Distinguished name (DN) of the internal account. Used for Swift correspondent payments.

Example request

{
  "name": "PartnerCo Main Account",
  "holder_name": "PartnerCo SAS",
  "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"
  },
  "organization_identification": {
    "legal_entity_identifier": "529900T8BM49AURSDO55",
    "business_identification_code": "SOMEBIC0XXX",
    "default_other_identifier_type": "siren",
    "others": [
      {
        "type": "siren",
        "value": "901250746"
      }
    ]
  },
  "currencies": [
    "EUR",
    "USD"
  ],
  "customer_bic": "BNPAFRPPXXX",
  "distinguished_name": "CN=foo,OU=bar,O=baz"
}

Response

200

idstring uuid required

The UUID of the internal account.

object'internal_account' required

The object, here internal_account.

status'pending_creation' | 'creation_rejected' | 'active' | 'blocked' | 'disabled' required

The status of the internal account.

type'own' | 'virtual' required

The type of the internal account.

namestring required

The name of the internal account.

account_numberstring required

The associated account number.

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

The format of the account number.

bank_codestring

The bank code of the account.

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

The format of the bank code.

holder_namestring required

The name of the holder the account belongs to.

alternative_holder_namesstring[]

Alternative account holder names, for instance if the account is a joint account.

account_holder_idstring uuid nullable

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

bank_namestring

The name of the bank holding the account.

creditor_identifierstring

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

custom_fieldsCommonCustomFields

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

metadataobject

Additional client data in JSON format. See Metadata.

created_atstring date-time required

The UTC timestamp of the creation of this internal account.

cbs_source'mambu'

The CBS this internal account refers to. Only mambu is supported.

cbs_account_idstring

The ID of the account in linked CBS. Must be provided if cbs_source is provided.

cbs_account_type'deposit'

The type of account in linked CBS. Only deposit supported. Must be provided if cbs_source is provided.