Get a List of Bank Details by Filter crm.requisite.bankdetail.list
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
Returns a list of banking details based on the filter.
Method Parameters
|
Name |
Description |
|
select |
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 |
An object for filtering the selected bank details in the format Possible values for An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected bank details in the format Possible values for Possible values for
|
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value The formula for calculating the
|
Description of Bank Detail Fields
|
Name |
Description |
|
ID |
Identifier of the bank details. Automatically created and unique within the account |
|
ENTITY_ID |
Identifier of the parent object. Currently can only be the identifier of the requisite. Identifiers of requisites can be obtained using the method |
|
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 |
|
DATE_CREATE |
Create date |
|
DATE_MODIFY |
Modification date |
|
CREATED_BY_ID |
Identifier of the user who created the requisite |
|
MODIFY_BY_ID |
Identifier of the user who modified the requisite |
|
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 '{"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
// 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
// Shape of each bank detail item returned in result[]
type BankDetailItem = {
ID: string
ENTITY_ID: string
NAME: string
}
try {
// crm.requisite.bankdetail.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<BankDetailItem[]>({
method: 'crm.requisite.bankdetail.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ENTITY_ID', 'ID', 'NAME'],
start: 0,
},
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 details count:', result.length, 'Items:', 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 listBankDetails() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.bankdetail.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.bankdetail.list',
params: {
order: { DATE_CREATE: 'ASC' },
filter: { COUNTRY_ID: '1' },
select: ['ENTITY_ID', 'ID', 'NAME'],
start: 0,
},
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 details count:', result.length, 'Items:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listBankDetails)
</script>
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>';
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.bankdetail.list(
order={"DATE_CREATE": "ASC"},
filter={"COUNTRY_ID": "1"},
select=["ENTITY_ID", "ID", "NAME"],
start=0,
).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}")
Example as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.bankdetail.list(
order={"DATE_CREATE": "ASC"},
filter={"COUNTRY_ID": "1"},
select=["ENTITY_ID", "ID", "NAME"],
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
Example as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.bankdetail.list(
filter={"COUNTRY_ID": "1"},
select=["ENTITY_ID", "ID", "NAME"],
order={"ID": "DESC"},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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": [
{
"ENTITY_ID": "27",
"ID": "11",
"NAME": "Chase"
},
{
"ENTITY_ID": "30",
"ID": "15",
"NAME": "Alpha Bank Corp."
},
{
"ENTITY_ID": "30",
"ID": "16",
"NAME": "Chase Bank Corp."
},
{
"ENTITY_ID": "45",
"ID": "17",
"NAME": "Chase Bank Corp."
},
{
"ENTITY_ID": "45",
"ID": "18",
"NAME": "Alpha Bank Corp."
}
],
"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 |
Description |
|
result |
An array of objects with information from the selected bank details. Each element contains the selected bank detail fields. |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "Access denied."
}
|
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 |
|
|
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 |
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 |