Create a new bank detail crm.requisite.bankdetail.add

Scope: crm

Who can execute the method: any user

This method creates a new bank detail.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

A set of fields — an object of the form {"field": "value"[, ...]} for adding a bank detail

Parameter fields

Required parameters are marked with *

Name
type

Description

ENTITY_ID*
integer

Identifier of the parent object. Currently, it can only be the identifier of the detail. Identifiers of details can be obtained using the method crm.requisite.list

COUNTRY_ID
integer

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 ENTITY_ID field

NAME*
string

Name of the bank detail

CODE
string

Symbolic code of the detail

XML_ID
string

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
char

Activity status. Values Y or N are used.

Currently, the field does not actually affect anything

SORT
integer

Sorting

RQ_BANK_NAME
string

Bank name

RQ_BANK_ADDR
string

Bank address

RQ_BANK_CODE
string

Bank code (for country BR)

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

RQ_BIK
string

BIK

RQ_CODEB
string

Code Banque (for country FR)

RQ_CODEG
string

Code Guichet (for country FR)

RQ_RIB
string

Clé RIB (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

Tipo da conta (for country BR)

RQ_AGENCY_NAME
string

Agência (for country BR)

RQ_IIK
string

IIK

RQ_ACC_CURRENCY
string

Account currency

RQ_COR_ACC_NUM
string

Correspondent account

RQ_IBAN
string

IBAN

RQ_SWIFT
string

SWIFT

RQ_BIC
string

BIC

COMMENTS
string

Comment

ORIGINATOR_ID
string

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
type

Description

result
integer

Identifier of the created bank detail

time
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
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

ENTITY_ID is not defined or invalid

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

Access denied

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
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 allowed to be called 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 methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users

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 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