Get a list of bank details by filter crm.requisite.bankdetail.list

Scope: crm

Who can execute the method: any user

The method returns a list of bank details based on the filter.

Method Parameters

Name `type`	Description
select `array`	The array contains a list of fields to select (see bank detail fields). If the array is not provided or an empty array is passed, all available bank detail fields will be selected.
filter `object`	An object for filtering the selected bank details in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` correspond to bank detail fields. An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` symbol does not need to be passed in the filter value. The search looks for the substring in any position of the string. `=%` — LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `%=` — LIKE (similar to `=%`) `!%` — NOT LIKE, substring search. The `%` symbol does not need to be passed in the filter value. The search goes from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol needs to be passed in the value. Examples: `"mol%"` — searches for values not starting with "mol" `"%mol"` — searches for values not ending with "mol" `"%mol%"` — searches for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (similar to `!=%`) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal
order `object`	An object for sorting the selected bank details in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to bank detail fields. Possible values for `order`: `asc` — in ascending order `desc` — in descending order
start `integer`	The parameter is used for managing pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value `50`. To select the third page of results, the value is `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` — the number of the desired page

Description of Bank Detail Fields

Name `type`	Description
ID `integer`	Identifier of the bank detail. Automatically created and unique within the account.
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.
DATE_CREATE `datetime`	Creation date.
DATE_MODIFY `datetime`	Modification date.
CREATED_BY_ID `user`	Identifier of the user who created the detail.
MODIFY_BY_ID `user`	Identifier of the user who modified the detail.
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 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. Values `Y` or `N` are used. 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`	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 Number.
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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ENTITY_ID","ID","NAME"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"COUNTRY_ID":"1"},"select":["ENTITY_ID","ID","NAME"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.list

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'crm.requisite.bankdetail.list',
            {
              order: { "DATE_CREATE": "ASC" },
              filter: { "COUNTRY_ID": "1" },
              select: [ "ENTITY_ID", "ID", "NAME" ]
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('crm.requisite.bankdetail.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COUNTRY_ID": "1" },
            select: [ "ENTITY_ID", "ID", "NAME" ]
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('crm.requisite.bankdetail.list', {
            order: { "DATE_CREATE": "ASC" },
            filter: { "COUNTRY_ID": "1" },
            select: [ "ENTITY_ID", "ID", "NAME" ]
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.bankdetail.list',
                    [
                        'order'  => ['DATE_CREATE' => 'ASC'],
                        'filter' => ['COUNTRY_ID' => '1'],
                        'select' => ['ENTITY_ID', 'ID', 'NAME'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
            if ($result->more()) {
                $result->next();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error listing bank details: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.bankdetail.list",
            {
                order: { "DATE_CREATE": "ASC" },
                filter: { "COUNTRY_ID": "1" },
                select: [ "ENTITY_ID", "ID", "NAME" ]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.dir(result.data());
                    if(result.more())
                        result.next();
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.bankdetail.list',
            [
                'order' => ['DATE_CREATE' => 'ASC'],
                'filter' => ['COUNTRY_ID' => '1'],
                'select' => ['ENTITY_ID', 'ID', 'NAME']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ENTITY_ID": "27",
                    "ID": "11",
                    "NAME": "Tinkoff"
                },
                {
                    "ENTITY_ID": "30",
                    "ID": "15",
                    "NAME": "ALPHA-BANK JSC"
                },
                {
                    "ENTITY_ID": "30",
                    "ID": "16",
                    "NAME": "Tinkoff Bank JSC"
                },
                {
                    "ENTITY_ID": "45",
                    "ID": "17",
                    "NAME": "Tinkoff Bank JSC"
                },
                {
                    "ENTITY_ID": "45",
                    "ID": "18",
                    "NAME": "ALPHA-BANK JSC"
                }
            ],
            "total": 5,
            "time": {
                "start": 1717498684.70562,
                "finish": 1717498685.13295,
                "duration": 0.42733001708984375,
                "processing": 0.020370006561279297,
                "date_start": "2024-06-04T12:58:04+02:00",
                "date_finish": "2024-06-04T12:58:05+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of objects with information from the selected bank details. Each element contains the selected bank detail fields.
total `integer`	Total number of records found.
time `time`	Information about the execution time of the request.

Error Handling

HTTP Status: 40x, 50x

{
            "error": "",
            "error_description": "Access denied."
        }

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
`Access denied`	Insufficient access permissions to retrieve the list of 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 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

Get Bank Detail by ID

Delete Bank Detail

Get a list of bank details by filter crm.requisite.bankdetail.list

Method ParametersMethod Parameters

Description of Bank Detail FieldsDescription of Bank Detail Fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning