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

Get bank detail

GET /v1/bank-details/:id

Returns a bank detail by ID with all record fields.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionBank detail ID

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/bank-details/19" \
  -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/19', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Account:', data.name, '— SWIFT', data.rqSwift)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/bank-details/19', {
  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 DescriptionAlways true on success
Fielddata Typeobject DescriptionThe bank detail object
Fielddata.id Typenumber DescriptionBank detail ID
Fielddata.entityId Typenumber DescriptionID of the owner requisite. Source: GET /v1/requisites
Fielddata.countryId Typenumber DescriptionCountry ID. 0 — country not set
Fielddata.name Typestring DescriptionBank detail name
Fielddata.active Typeboolean DescriptionWhether the record is active
Fielddata.sort Typenumber DescriptionSort order
Fielddata.code Typestring | null DescriptionSymbolic code for external integrations
Fielddata.xmlId Typestring | null DescriptionExternal identifier for synchronization
Fielddata.originatorId Typestring | null DescriptionSource system ID
Fielddata.comments Typestring | null DescriptionComment on the record
Fielddata.createdAt Typedatetime DescriptionCreation date (ISO 8601)
Fielddata.updatedAt Typedatetime | null DescriptionLast modification date (ISO 8601)
Fielddata.createdBy Typenumber DescriptionCreator ID
Fielddata.modifyBy Typenumber | null DescriptionLast editor ID
Fielddata.rqBankName Typestring | null DescriptionBank name
Fielddata.rqBankAddr Typestring | null DescriptionBank address
Fielddata.rqBankRouteNum Typestring | null DescriptionBank routing number
Fielddata.rqBankCode Typestring | null DescriptionBank code
Fielddata.rqBik Typestring | null DescriptionBIC
Fielddata.rqAccNum Typestring | null DescriptionCurrent account
Fielddata.rqCorAccNum Typestring | null DescriptionCorrespondent account
Fielddata.rqSwift Typestring | null DescriptionSWIFT code
Fielddata.rqIban Typestring | null DescriptionIBAN
Fielddata.rqIik Typestring | null DescriptionIIK (Kazakhstan)
Fielddata.rqMfo Typestring | null DescriptionMFO (Ukraine)
Fielddata.rqAccName Typestring | null DescriptionAccount name
Fielddata.rqAccCurrency Typestring | null DescriptionAccount currency
Fielddata.rqAccType Typestring | null DescriptionAccount type
Fielddata.rqAgencyName Typestring | null DescriptionAgency name
Fielddata.rqBic Typestring | null DescriptionBIC (international, separate from rqBik)
Fielddata.rqCodeb Typestring | null DescriptionBank code (France, RQ_CODEB)
Fielddata.rqCodeg Typestring | null DescriptionBranch code (France, RQ_CODEG)
Fielddata.rqRib Typestring | null DescriptionRIB (France)

Full list of fields with types and the readonly flag — Bank detail fields.

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 19,
    "entityId": 1,
    "countryId": 0,
    "createdAt": "2026-06-10T10:14:29.000Z",
    "updatedAt": null,
    "createdBy": 1,
    "modifyBy": null,
    "name": "Current account",
    "code": null,
    "xmlId": null,
    "originatorId": null,
    "active": true,
    "sort": 500,
    "rqBankName": "First National Bank",
    "rqBankCode": null,
    "rqBankAddr": null,
    "rqBankRouteNum": "021000021",
    "rqBik": null,
    "rqMfo": null,
    "rqAccName": null,
    "rqAccNum": "1234567890",
    "rqAccType": null,
    "rqIik": null,
    "rqAccCurrency": null,
    "rqCorAccNum": null,
    "rqIban": null,
    "rqSwift": "CHASUS33",
    "rqBic": null,
    "rqCodeb": null,
    "rqCodeg": null,
    "rqRib": null,
    "rqAgencyName": null,
    "comments": null
  }
}

Error response example

404 — bank detail not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The RequisiteBankDetail with ID '999999' is not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo bank detail with this ID found
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

Known specifics

entityTypeId is absent from the response. The entityTypeId field is passed on bank detail creation (always 8 — requisite), but it is not returned in the get and list responses. This is an owner field, write-only.

countryId equals 0 for records without a country. If no country is set on creation, the field returns the numeric value 0, not null.

See also