Get Bank Details by Id crm.requisite.bankdetail.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with "read" access permission for the contact or company that owns the requisite
The method returns bank details by identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the bank details. Identifiers of bank details can be obtained using the method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":357}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.bankdetail.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":357,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.bankdetail.get
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type BankDetailGetResult = {
ID: string
ENTITY_ID: string
COUNTRY_ID: string
DATE_CREATE: ISODate | null
DATE_MODIFY: ISODate | null
CREATED_BY_ID: string
MODIFY_BY_ID: string | null
NAME: string
CODE: string | null
XML_ID: string
ORIGINATOR_ID: string | null
ACTIVE: string
SORT: string
RQ_BANK_NAME: string | null
RQ_BANK_CODE: string | null
RQ_BANK_ADDR: string | null
RQ_BANK_ROUTE_NUM: string | null
RQ_BIK: string | null
RQ_MFO: string | null
RQ_ACC_NAME: string | null
RQ_ACC_NUM: string | null
RQ_ACC_TYPE: string | null
RQ_IIK: string | null
RQ_ACC_CURRENCY: string | null
RQ_COR_ACC_NUM: string | null
RQ_IBAN: string | null
RQ_SWIFT: string | null
RQ_BIC: string | null
RQ_CODEB: string | null
RQ_CODEG: string | null
RQ_RIB: string | null
RQ_AGENCY_NAME: string | null
COMMENTS: string | null
}
try {
const response = await $b24.actions.v2.call.make<BankDetailGetResult>({
method: 'crm.requisite.bankdetail.get',
params: {
id: 357,
},
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 detail:', result.ID, result.NAME, result.RQ_BIK)
}
} 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 getBankDetail() {
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.get',
params: {
id: 357,
},
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 detail:', result.ID, result.NAME, result.RQ_BIK)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getBankDetail)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.bankdetail.get(bitrix_id=357).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}")
try {
$response = $b24Service
->core
->call(
'crm.requisite.bankdetail.get',
[
'id' => 357,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting bank detail: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.bankdetail.get",
{ id: 357 },
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.bankdetail.get',
['id' => 357]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.requisite.bankdetail.get", b24.Params{
"id": 357,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.requisite.bankdetail.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
EntityID b24.ID `json:"ENTITY_ID"`
CountryID b24.ID `json:"COUNTRY_ID"`
DateCreate string `json:"DATE_CREATE"`
DateModify string `json:"DATE_MODIFY"`
CreatedByID b24.ID `json:"CREATED_BY_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.EntityID)
Response Handling
HTTP status: 200
{
"result": {
"ID": "357",
"ENTITY_ID": "27",
"COUNTRY_ID": "1",
"DATE_CREATE": "2024-06-03T17:52:22+02:00",
"DATE_MODIFY": "",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": null,
"NAME": "Ltd. Superbank",
"CODE": null,
"XML_ID": "1e4641fd-2dd9-31e6-b2f2-105056c00008",
"ORIGINATOR_ID": null,
"ACTIVE": "Y",
"SORT": "600",
"RQ_BANK_NAME": "Ltd. Superbank",
"RQ_BANK_CODE": null,
"RQ_BANK_ADDR": "10001, New York, 19 Miller St.",
"RQ_BANK_ROUTE_NUM": null,
"RQ_BIK": "123456789",
"RQ_MFO": null,
"RQ_ACC_NAME": null,
"RQ_ACC_NUM": "9876543210",
"RQ_ACC_TYPE": null,
"RQ_IIK": null,
"RQ_ACC_CURRENCY": "USD",
"RQ_COR_ACC_NUM": "1234567890",
"RQ_IBAN": null,
"RQ_SWIFT": null,
"RQ_BIC": null,
"RQ_CODEB": null,
"RQ_CODEG": null,
"RQ_RIB": null,
"RQ_AGENCY_NAME": null,
"COMMENTS": null
},
"time": {
"start": 1717495619.077607,
"finish": 1717495619.708617,
"duration": 0.6310100555419922,
"processing": 0.07691788673400879,
"date_start": "2024-06-04T12:06:59+02:00",
"date_finish": "2024-06-04T12:06:59+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the values of the bank details fields |
|
time |
Information about the request execution time |
Description of Bank Details Fields
|
Name |
Description |
|
ID |
Identifier of the bank details. Automatically created and unique within the account |
|
ENTITY_TYPE_ID |
Identifier of the parent object's type. Can only be Identifiers of object types are returned by the method crm.enum.ownertype |
|
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_BIC |
BIC |
|
COMMENTS |
Comment |
|
ORIGINATOR_ID |
Identifier of the external information base. The purpose of the field may change by the final developer |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "The RequisiteBankDetail with ID '357' is not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Error text |
Description |
|
|
The identifier of the bank details is not defined or has an invalid value |
|
|
The bank detail with the specified identifier was not found |
|
|
Insufficient access permissions to retrieve bank details |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |