For AI agents: markdown of this page — /docs-content-en/entities/bank-details/fields.md documentation index — /llms.txt

Bank detail fields

GET /v1/bank-details/fields

Returns the schema of all bank detail fields: type, read-only flag, required-on-create flag, label, and description.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/bank-details/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/bank-details/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('All fields:', Object.keys(data.fields))

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.fields Typeobject DescriptionField schema: the key is the field name, the value is an object describing the field. The fields are listed in the tables below
Fielddata.fields.<field>.type Typestring DescriptionValue type: number, string, boolean, datetime
Fielddata.fields.<field>.readonly Typeboolean Descriptiontrue — the field is not accepted on create or update
Fielddata.fields.<field>.required Typeboolean Descriptiontrue — the field is required on create. The key is present only with the value true
Fielddata.fields.<field>.notReturned Typeboolean Descriptiontrue — the field is accepted on write but does not come back in responses. The key is present only with the value true
Fielddata.fields.<field>.multiple Typeboolean Descriptiontrue — the field holds multiple values. A missing key does not mean the field is single-valued
Fielddata.fields.<field>.label Typestring DescriptionField name in English
Fielddata.fields.<field>.description Typestring DescriptionField description in English
Fielddata.batch Typearray DescriptionWrite operations available in batch calls: create, update, delete
Fieldmeta.warnings Typearray DescriptionPresent when the Bitrix24 account's user fields could not be retrieved: meta.warnings[].code is fields_partial, and data.fields contains only the fields from the tables below

Request headers do not switch the language of labels and descriptions.

The entityTypeId field is marked notReturned: true: it is accepted on write but does not come back in responses. An explicit select=entityTypeId returns an UNKNOWN_SELECT_FIELD warning, and the field is absent from the response. Do not include it in select.

Service

Field Type RO Description
Fieldid Typenumber ROyes DescriptionBank detail ID
FieldentityTypeId Typenumber ROno DescriptionOwner entity type. Always 8 (requisite). Write-only, not returned in the get response
FieldentityId Typenumber ROno DescriptionID of the owner requisite. List: GET /v1/requisites
FieldcountryId Typenumber ROno DescriptionCountry ID. 0 — country not set. List: GET /v1/requisite-presets/countries
Fieldname Typestring ROno DescriptionBank detail name
Fieldcode Typestring ROno DescriptionSymbolic code for external integrations
FieldxmlId Typestring ROno DescriptionExternal identifier for synchronization
FieldoriginatorId Typestring ROno DescriptionSource system ID
Fieldactive Typeboolean ROno DescriptionWhether the record is active
Fieldsort Typenumber ROno DescriptionSort order
Fieldcomments Typestring ROno DescriptionComment on the record
FieldcreatedAt Typedatetime ROyes DescriptionCreation date in ISO 8601 format
FieldupdatedAt Typedatetime ROyes DescriptionLast modification date in ISO 8601 format
FieldcreatedBy Typenumber ROyes DescriptionCreator ID
FieldmodifyBy Typenumber ROyes DescriptionLast editor ID

Bank details

Field Type RO Description
FieldrqBankName Typestring ROno DescriptionBank name
FieldrqBankAddr Typestring ROno DescriptionBank address
FieldrqBankRouteNum Typestring ROno DescriptionBank routing number
FieldrqBankCode Typestring ROno DescriptionBank code
FieldrqBik Typestring ROno DescriptionBIK
FieldrqMfo Typestring ROno DescriptionMFO, Ukraine
FieldrqAccName Typestring ROno DescriptionAccount name
FieldrqAccNum Typestring ROno DescriptionCurrent account
FieldrqAccType Typestring ROno DescriptionAccount type
FieldrqCorAccNum Typestring ROno DescriptionCorrespondent account
FieldrqAccCurrency Typestring ROno DescriptionAccount currency
FieldrqIik Typestring ROno DescriptionIIK, Kazakhstan
FieldrqAgencyName Typestring ROno DescriptionAgency name

International details

Field Type RO Description
FieldrqIban Typestring ROno DescriptionIBAN
FieldrqSwift Typestring ROno DescriptionSWIFT code

French details

Field Type RO Description
FieldrqBic Typestring ROno DescriptionBIC in the French form. A separate field, not rqBik
FieldrqCodeb Typestring ROno DescriptionBank code
FieldrqCodeg Typestring ROno DescriptionBank branch code
FieldrqRib Typestring ROno DescriptionRIB — bank account identifier

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Bank detail ID", "description": "Bank detail ID." },
      "entityTypeId": { "type": "number", "readonly": false, "notReturned": true, "label": "Owner entity type", "description": "Owner entity type. Always 8 (requisite). Write-only — not returned in the get response." },
      "entityId": { "type": "number", "readonly": false, "required": true, "label": "Owner requisite ID", "description": "ID of the owner requisite." },
      "countryId": { "type": "number", "readonly": false, "label": "Country ID", "description": "Country ID. 0 means the country is not set." },
      "name": { "type": "string", "readonly": false, "required": true, "label": "Bank detail name", "description": "Bank detail name." },
      "code": { "type": "string", "readonly": false, "label": "Symbolic code", "description": "Symbolic code for external integrations." },
      "xmlId": { "type": "string", "readonly": false, "label": "External ID", "description": "External identifier for synchronization." },
      "originatorId": { "type": "string", "readonly": false, "label": "Source system ID", "description": "Source system ID." },
      "active": { "type": "boolean", "readonly": false, "label": "Active", "description": "Whether the record is active." },
      "sort": { "type": "number", "readonly": false, "label": "Sort order", "description": "Sort order." },
      "comments": { "type": "string", "readonly": false, "label": "Comment", "description": "Comment on the record." },
      "createdAt": { "type": "datetime", "readonly": true, "label": "Created at", "description": "Creation date (ISO 8601)." },
      "updatedAt": { "type": "datetime", "readonly": true, "label": "Updated at", "description": "Last modification date (ISO 8601)." },
      "createdBy": { "type": "number", "readonly": true, "label": "Created by", "description": "Creator ID." },
      "modifyBy": { "type": "number", "readonly": true, "label": "Modified by", "description": "Last editor ID." },
      "rqBankName": { "type": "string", "readonly": false, "label": "Bank name", "description": "Bank name." },
      "rqBankAddr": { "type": "string", "readonly": false, "label": "Bank address", "description": "Bank address." },
      "rqBankRouteNum": { "type": "string", "readonly": false, "label": "Bank routing number", "description": "Bank routing number." },
      "rqBankCode": { "type": "string", "readonly": false, "label": "Bank code", "description": "Bank code." },
      "rqAccNum": { "type": "string", "readonly": false, "label": "Current account", "description": "Current account number." },
      "rqCorAccNum": { "type": "string", "readonly": false, "label": "Correspondent account", "description": "Correspondent account number." },
      "rqIik": { "type": "string", "readonly": false, "label": "IIK (Kazakhstan)", "description": "IIK — the Kazakhstan account identifier." },
      "rqMfo": { "type": "string", "readonly": false, "label": "MFO (Ukraine)", "description": "MFO — the Ukrainian bank code." },
      "rqAccName": { "type": "string", "readonly": false, "label": "Account name", "description": "Account name." },
      "rqAccCurrency": { "type": "string", "readonly": false, "label": "Account currency", "description": "Account currency." },
      "rqBik": { "type": "string", "readonly": false, "label": "BIC", "description": "BIC — the Russian bank identification code." },
      "rqSwift": { "type": "string", "readonly": false, "label": "SWIFT code", "description": "SWIFT code." },
      "rqIban": { "type": "string", "readonly": false, "label": "IBAN", "description": "IBAN — the international bank account number." },
      "rqAgencyName": { "type": "string", "readonly": false, "label": "Agency name", "description": "Agency name." },
      "rqAccType": { "type": "string", "readonly": false, "label": "Account type", "description": "Account type." },
      "rqBic": { "type": "string", "readonly": false, "label": "BIC (French form)", "description": "BIC in the French form; a separate field from rqBik." },
      "rqCodeb": { "type": "string", "readonly": false, "label": "Bank code (France)", "description": "Bank code in the French banking system." },
      "rqCodeg": { "type": "string", "readonly": false, "label": "Branch code (France)", "description": "Branch code in the French banking system." },
      "rqRib": { "type": "string", "readonly": false, "label": "RIB (France)", "description": "RIB — the French bank account identifier." }
    },
    "batch": ["create", "update", "delete"]
  }
}

Error response example

401 — key not provided:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not provided
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope. Message: This endpoint requires 'crm' scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

See also