Create a new bank detail crm.requisite.bankdetail.add
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* |
Identifier of the parent object. Currently, it can only be the identifier of the detail. Identifiers of details can be obtained using the method |
|
COUNTRY_ID |
Identifier of the country corresponding to the set of bank detail fields (see the method crm.requisite.preset.countries for available values). The country code of the bank detail matches the country code in the linked detail template, the identifier of which is specified in the |
|
NAME* |
Name of the bank detail |
|
CODE |
Symbolic code of the detail |
|
XML_ID |
External key. Used for exchange operations. Identifier of the external information base object. 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 status. Values Currently, the field does not actually affect anything |
|
SORT |
Sorting |
|
RQ_BANK_NAME |
Bank name |
|
RQ_BANK_ADDR |
Bank address |
|
RQ_BANK_CODE |
Bank code (for country BR) |
|
RQ_BANK_ROUTE_NUM |
Bank Routing Number |
|
RQ_BIK |
BIK |
|
RQ_CODEB |
Code Banque (for country FR) |
|
RQ_CODEG |
Code Guichet (for country FR) |
|
RQ_RIB |
Clé RIB (for country FR) |
|
RQ_MFO |
MFO |
|
RQ_ACC_NAME |
Bank Account Holder Name |
|
RQ_ACC_NUM |
Bank Account Number |
|
RQ_ACC_TYPE |
Tipo da conta (for country BR) |
|
RQ_AGENCY_NAME |
Agência (for country BR) |
|
RQ_IIK |
IIK |
|
RQ_ACC_CURRENCY |
Account currency |
|
RQ_COR_ACC_NUM |
Correspondent account |
|
RQ_IBAN |
IBAN |
|
RQ_SWIFT |
SWIFT |
|
RQ_BIC |
BIC |
|
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
try
{
const response = await $b24.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
}
}
);
const result = response.getData().result;
console.info("Created bank detail with ID " + result);
}
catch(error)
{
console.error(error);
}
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 'Created bank detail 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("Created bank detail 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>';
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 execution time of the request |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update Bank Details crm.requisite.bankdetail.update
- Get bank details by id crm.requisite.bankdetail.get
- Get a list of bank details by filter crm.requisite.bankdetail.list
- Delete bank detail crm.requisite.bankdetail.delete
- Get Description of Bank Details Fields crm.requisite.bankdetail.fields