Get Bank Details by Id crm.requisite.bankdetail.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: any user

The method returns bank details by identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the bank details.

Identifiers of bank details can be obtained using the method crm.requisite.bankdetail.list

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":357}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":357,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type BankDetailGetResult = {
          ID: string
          ENTITY_ID: string
          COUNTRY_ID: string
          DATE_CREATE: ISODate | null
          DATE_MODIFY: ISODate | null
          CREATED_BY_ID: string
          MODIFY_BY_ID: string | null
          NAME: string
          CODE: string | null
          XML_ID: string
          ORIGINATOR_ID: string | null
          ACTIVE: string
          SORT: string
          RQ_BANK_NAME: string | null
          RQ_BANK_CODE: string | null
          RQ_BANK_ADDR: string | null
          RQ_BANK_ROUTE_NUM: string | null
          RQ_BIK: string | null
          RQ_MFO: string | null
          RQ_ACC_NAME: string | null
          RQ_ACC_NUM: string | null
          RQ_ACC_TYPE: string | null
          RQ_IIK: string | null
          RQ_ACC_CURRENCY: string | null
          RQ_COR_ACC_NUM: string | null
          RQ_IBAN: string | null
          RQ_SWIFT: string | null
          RQ_BIK: string | null
          RQ_CODEB: string | null
          RQ_CODEG: string | null
          RQ_RIB: string | null
          RQ_AGENCY_NAME: string | null
          COMMENTS: string | null
        }
        
        try {
          const response = await $b24.actions.v2.call.make<BankDetailGetResult>({
            method: 'crm.requisite.bankdetail.get',
            params: {
              id: 357,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Bank detail:', result.ID, result.NAME, result.RQ_BIK)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getBankDetail() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.requisite.bankdetail.get',
                params: {
                  id: 357,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Bank detail:', result.ID, result.NAME, result.RQ_BIK)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getBankDetail)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.bankdetail.get',
                    [
                        'id' => 357,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting bank detail: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.bankdetail.get",
            { id: 357 },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.bankdetail.get',
            ['id' => 357]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.requisite.bankdetail.get(bitrix_id=357).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

Response Handling

HTTP status: 200

{
            "result": {
                "ID": "357",
                "ENTITY_ID": "27",
                "COUNTRY_ID": "1",
                "DATE_CREATE": "2024-06-03T17:52:22+02:00",
                "DATE_MODIFY": "",
                "CREATED_BY_ID": "1",
                "MODIFY_BY_ID": null,
                "NAME": "Ltd. Superbank",
                "CODE": null,
                "XML_ID": "1e4641fd-2dd9-31e6-b2f2-105056c00008",
                "ORIGINATOR_ID": null,
                "ACTIVE": "Y",
                "SORT": "600",
                "RQ_BANK_NAME": "Ltd. Superbank",
                "RQ_BANK_CODE": null,
                "RQ_BANK_ADDR": "117312, New York, 19 Miller St.",
                "RQ_BANK_ROUTE_NUM": null,
                "RQ_BIK": "044525225",
                "RQ_MFO": null,
                "RQ_ACC_NAME": null,
                "RQ_ACC_NUM": "40702810938000060473",
                "RQ_ACC_TYPE": null,
                "RQ_IIK": null,
                "RQ_ACC_CURRENCY": "USD",
                "RQ_COR_ACC_NUM": "30101810400000000225",
                "RQ_IBAN": null,
                "RQ_SWIFT": null,
                "RQ_BIK": null,
                "RQ_CODEB": null,
                "RQ_CODEG": null,
                "RQ_RIB": null,
                "RQ_AGENCY_NAME": null,
                "COMMENTS": null
            },
            "time": {
                "start": 1717495619.077607,
                "finish": 1717495619.708617,
                "duration": 0.6310100555419922,
                "processing": 0.07691788673400879,
                "date_start": "2024-06-04T12:06:59+02:00",
                "date_finish": "2024-06-04T12:06:59+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object containing the values of the bank details fields

time
time

Information about the request execution time

Description of Bank Details Fields

Name
type

Description

ID
integer

Identifier of the bank details. Automatically created and unique within the account

ENTITY_TYPE_ID
integer

Identifier of the parent object's type. Can only be Requisite (value 8).

Identifiers of object types are returned by the method crm.enum.ownertype

ENTITY_ID
integer

Identifier of the parent object. Currently can only be the identifier of the requisite.

Identifiers of requisites can be obtained using the method crm.requisite.list

COUNTRY_ID
integer

Identifier of the country corresponding to the set of bank details fields (see method crm.requisite.preset.countries for available values).

The country code of the bank details matches the country code in the linked requisite template, the identifier of which is specified in the ENTITY_ID field

DATE_CREATE
datetime

Create date

DATE_MODIFY
datetime

Modification date

CREATED_BY_ID
user

Identifier of the user who created the requisite

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

NAME*
string

Name of the bank details

CODE
string

Symbolic code of the requisite

XML_ID
string

External key. Used for exchange operations. Identifier of the object in the external information base.

The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field.

It is recommended to use a unique prefix to avoid collisions with other applications

ACTIVE
char

Activity indicator. Uses values Y or N.

Currently, the field does not actually affect anything

SORT
integer

Sorting

RQ_BANK_NAME
string

Name of the bank

RQ_BANK_ADDR
string

Address of the bank

RQ_BANK_CODE
string

Bank Code (for country BR)

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

RQ_BIK
string

BIK

RQ_CODEB
string

Bank Code (for country FR)

RQ_CODEG
string

Branch Code (for country FR)

RQ_RIB
string

RIB Key (for country FR)

RQ_MFO
string

MFO

RQ_ACC_NAME
string

Bank Account Holder Name

RQ_ACC_NUM
string

Bank Account Number

RQ_ACC_TYPE
string

Account Type (for country BR)

RQ_AGENCY_NAME
string

Agency (for country BR)

RQ_IIK
string

IIK

RQ_ACC_CURRENCY
string

Currency of the account

RQ_COR_ACC_NUM
string

Correspondent account

RQ_IBAN
string

IBAN

RQ_SWIFT
string

SWIFT

RQ_BIK
string

BIK

COMMENTS
string

Comment

ORIGINATOR_ID
string

Identifier of the external information base. The purpose of the field may change by the final developer

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "The RequisiteBankDetail with ID '357' is not found"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Errors

Error text

Description

ID is not defined or invalid

The identifier of the bank details is not defined or has an invalid value

The RequisiteBankDetail with ID '357' is not found

The bank detail with the specified identifier was not found

Access denied

Insufficient access permissions to retrieve bank details

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning