Create a New Bank Detail crm.requisite.bankdetail.add
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:
crmWho can execute the method: any user
This method creates a new bank detail.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
A set of fields — an object of the form |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
ENTITY_ID* |
Parent object identifier. Currently, it can only be an attribute identifier. Attribute identifiers can be obtained using the |
|
COUNTRY_ID |
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 |
|
NAME* |
Name of the bank details |
|
CODE |
Symbolic code of the requisite |
|
XML_ID |
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 |
Activity indicator. Uses values Currently, the field does not actually affect anything |
|
SORT |
Sorting |
|
RQ_BANK_NAME |
Name of the bank |
|
RQ_BANK_ADDR |
Address of the bank |
|
RQ_BANK_CODE |
Bank Code (for country BR) |
|
RQ_BANK_ROUTE_NUM |
Bank Routing Number |
|
RQ_BIK |
BIK |
|
RQ_CODEB |
Bank Code (for country FR) |
|
RQ_CODEG |
Branch Code (for country FR) |
|
RQ_RIB |
RIB Key (for country FR) |
|
RQ_MFO |
MFO |
|
RQ_ACC_NAME |
Bank Account Holder Name |
|
RQ_ACC_NUM |
Bank Account Number |
|
RQ_ACC_TYPE |
Account Type (for country BR) |
|
RQ_AGENCY_NAME |
Agency (for country BR) |
|
RQ_IIK |
IIK |
|
RQ_ACC_CURRENCY |
Currency of the account |
|
RQ_COR_ACC_NUM |
Correspondent account |
|
RQ_IBAN |
IBAN |
|
RQ_SWIFT |
SWIFT |
|
RQ_BIK |
BIK |
|
COMMENTS |
Comment |
|
ORIGINATOR_ID |
Identifier of the external information base. The purpose of the field may change by the final developer |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":27,"COUNTRY_ID":1,"NAME":"Superbank","RQ_BANK_NAME":"Ltd. Superbank","RQ_BANK_ADDR":"117312, New York, 19 Miller St.","RQ_BIK":"044525225","RQ_ACC_NUM":"40702810938000060473","RQ_ACC_CURRENCY":"USD","RQ_COR_ACC_NUM":"30101810400000000225","XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008","ACTIVE":"Y","SORT":600}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":27,"COUNTRY_ID":1,"NAME":"Superbank","RQ_BANK_NAME":"Ltd. Superbank","RQ_BANK_ADDR":"117312, New York, 19 Miller St.","RQ_BIK":"044525225","RQ_ACC_NUM":"40702810938000060473","RQ_ACC_CURRENCY":"USD","RQ_COR_ACC_NUM":"30101810400000000225","XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008","ACTIVE":"Y","SORT":600},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.add
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'crm.requisite.bankdetail.add',
params: {
fields: {
ENTITY_ID: 27, // Requisite ID
COUNTRY_ID: 1, // Country code
NAME: 'Superbank', // Bank detail name
RQ_BANK_NAME: 'JSC Superbank', // Bank name
RQ_BANK_ADDR: '117312, New York, 19 Miller St.',
RQ_BIK: '044525225',
RQ_ACC_NUM: '40702810938000060473',
RQ_ACC_CURRENCY: 'USD',
RQ_COR_ACC_NUM: '30101810400000000225',
XML_ID: '1e4641fd-2dd9-31e6-b2f2-105056c00008',
ACTIVE: 'Y',
SORT: 600,
},
},
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('Created bank detail with ID:', result)
}
} 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 addBankDetail() {
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.add',
params: {
fields: {
ENTITY_ID: 27, // Requisite ID
COUNTRY_ID: 1, // Country code (Russia)
NAME: 'Superbank', // Bank detail name
RQ_BANK_NAME: 'JSC Superbank', // Bank name
RQ_BANK_ADDR: '117312, New York, 19 Miller St.',
RQ_BIK: '044525225',
RQ_ACC_NUM: '40702810938000060473',
RQ_ACC_CURRENCY: 'USD',
RQ_COR_ACC_NUM: '30101810400000000225',
XML_ID: '1e4641fd-2dd9-31e6-b2f2-105056c00008',
ACTIVE: 'Y',
SORT: 600,
},
},
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('Created bank detail with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addBankDetail)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.bankdetail.add',
[
'fields' => [
'ENTITY_ID' => 27,
'COUNTRY_ID' => 1,
'NAME' => 'Superbank',
'RQ_BANK_NAME' => 'Ltd. Superbank',
'RQ_BANK_ADDR' => '117312, New York, 19 Miller St.',
'RQ_BIK' => '044525225',
'RQ_ACC_NUM' => '40702810938000060473',
'RQ_ACC_CURRENCY' => 'USD',
'RQ_COR_ACC_NUM' => '30101810400000000225',
'XML_ID' => '1e4641fd-2dd9-31e6-b2f2-105056c00008',
'ACTIVE' => 'Y',
'SORT' => 600,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Bank details created with ID ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating bank detail: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.bankdetail.add",
{
fields:
{
"ENTITY_ID": 27, // Identifier of the detail
"COUNTRY_ID": 1, // Country code (USA)
"NAME": "Superbank", // Name of the bank detail
"RQ_BANK_NAME": "Ltd. Superbank", // Bank name
"RQ_BANK_ADDR": "117312, New York, 19 Miller St.",
"RQ_BIK": "044525225",
"RQ_ACC_NUM": "40702810938000060473",
"RQ_ACC_CURRENCY": "USD",
"RQ_COR_ACC_NUM": "30101810400000000225",
"XML_ID":"1e4641fd-2dd9-31e6-b2f2-105056c00008",
"ACTIVE":"Y",
"SORT":600
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info("Bank details created with ID " + result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.bankdetail.add',
[
'fields' => [
'ENTITY_ID' => 27,
'COUNTRY_ID' => 1,
'NAME' => 'Superbank',
'RQ_BANK_NAME' => 'Ltd. Superbank',
'RQ_BANK_ADDR' => '117312, New York, 19 Miller St.',
'RQ_BIK' => '044525225',
'RQ_ACC_NUM' => '40702810938000060473',
'RQ_ACC_CURRENCY' => 'USD',
'RQ_COR_ACC_NUM' => '30101810400000000225',
'XML_ID' => '1e4641fd-2dd9-31e6-b2f2-105056c00008',
'ACTIVE' => 'Y',
'SORT' => 600
]
]
);
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.add(
fields={
"ENTITY_ID": 27,
"COUNTRY_ID": 1,
"NAME": "Superbank",
"RQ_BANK_NAME": "Ltd. Superbank",
"RQ_BANK_ADDR": "117312, New York, 19 Miller St.",
"RQ_BIK": "044525225",
"RQ_ACC_NUM": "40702810938000060473",
"RQ_ACC_CURRENCY": "USD",
"RQ_COR_ACC_NUM": "30101810400000000225",
"XML_ID": "1e4641fd-2dd9-31e6-b2f2-105056c00008",
"ACTIVE": "Y",
"SORT": 600,
},
).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": 357,
"time": {
"start": 1717429942.060649,
"finish": 1717429942.626925,
"duration": 0.5662760734558105,
"processing": 0.09111285209655762,
"date_start": "2024-06-03T17:52:22+02:00",
"date_finish": "2024-06-03T17:52:22+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created bank detail |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "ENTITY_ID is not defined or invalid."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
The identifier of the detail is not defined or has an invalid value |
|
|
Insufficient access permissions to add a bank detail |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |