Получить банковский реквизит по id crm.requisite.bankdetail.get

Scope: crm

Кто может выполнять метод: любой пользователь

Метод возвращает банковский реквизит по идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор банковского реквизита.

Идентификаторы банковских реквизитов можно получить с помощью метода crm.requisite.bankdetail.list

Примеры кода

Как использовать примеры в документации

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
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.requisite.bankdetail.get',
        		{ id: 357 }
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('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>';

Обработка ответа

HTTP-статус: 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": "ПАО Супербанк",
                "CODE": null,
                "XML_ID": "1e4641fd-2dd9-31e6-b2f2-105056c00008",
                "ORIGINATOR_ID": null,
                "ACTIVE": "Y",
                "SORT": "600",
                "RQ_BANK_NAME": "ПАО Супербанк",
                "RQ_BANK_CODE": null,
                "RQ_BANK_ADDR": "117312, г. Москва, улица Вавилова, дом 19",
                "RQ_BANK_ROUTE_NUM": null,
                "RQ_BIK": "044525225",
                "RQ_MFO": null,
                "RQ_ACC_NAME": null,
                "RQ_ACC_NUM": "40702810938000060473",
                "RQ_ACC_TYPE": null,
                "RQ_IIK": null,
                "RQ_ACC_CURRENCY": "RUR",
                "RQ_COR_ACC_NUM": "30101810400000000225",
                "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
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Объект, содержащий значения полей банковского реквизита

time
time

Информация о времени выполнения запроса

Описание полей банковского реквизита

Название
тип

Описание

ID
integer

Идентификатор банковского реквизита. Создается автоматически и уникален в рамках портала

ENTITY_TYPE_ID
integer

Идентификатор типа родительского объекта. Может быть только Реквизит (значение 8).

Идентификаторы типов объектов возвращает метод crm.enum.ownertype

ENTITY_ID
integer

Идентификатор родительского объекта. Сейчас может быть только идентификатор реквизита.

Идентификаторы реквизитов можно получить с помощью метода crm.requisite.list

COUNTRY_ID
integer

Идентификатор страны, которой соответствует набор полей банковского реквизита (смотрите метод crm.requisite.preset.countries для получения доступных значений).

Код страны банковского реквизита совпадает с кодом страны в привязанном шаблоне реквизитов, идентификатор которого указан в поле ENTITY_ID

DATE_CREATE
datetime

Дата создания

DATE_MODIFY
datetime

Дата изменения

CREATED_BY_ID
user

Идентификатор пользователя, создавшего реквизит

MODIFY_BY_ID
user

Идентификатор пользователя, изменившего реквизит

NAME*
string

Название банковского реквизита

CODE
string

Символьный код реквизита

XML_ID
string

Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы.

Назначение поля может меняться конечным разработчиком. Каждое приложение обеспечивает уникальность значений в этом поле.

Рекомендуется использовать уникальный префикс для избежания коллизий с другими приложениями

ACTIVE
char

Признак активности. Используются значения Y или N.

Сейчас поле фактически ни на что не влияет

SORT
integer

Сортировка

RQ_BANK_NAME
string

Наименование банка

RQ_BANK_ADDR
string

Адрес банка

RQ_BANK_CODE
string

Código do banco (для страны BR)

RQ_BANK_ROUTE_NUM
string

Bank Routing Number

RQ_BIK
string

БИК

RQ_CODEB
string

Code Banque (для страны FR)

RQ_CODEG
string

Code Guichet (для страны FR)

RQ_RIB
string

Clé RIB (для страны FR)

RQ_MFO
string

МФО

RQ_ACC_NAME
string

Bank Account Holder Name

RQ_ACC_NUM
string

Bank Account Number

RQ_ACC_TYPE
string

Tipo da conta (для страны BR)

RQ_AGENCY_NAME
string

Agência (для страны BR)

RQ_IIK
string

ИИК

RQ_ACC_CURRENCY
string

Валюта счета

RQ_COR_ACC_NUM
string

Корреспондентский счет

RQ_IBAN
string

IBAN

RQ_SWIFT
string

SWIFT

RQ_BIC
string

BIC

COMMENTS
string

Комментарий

ORIGINATOR_ID
string

Идентификатор внешней информационной базы. Назначение поля может меняться конечным разработчиком

Обработка ошибок

HTTP-статус: 40x, 50x

{
            "error": "",
            "error_description": "The RequisiteBankDetail with ID '357' is not found"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные ошибки

Текст ошибки

Описание

ID is not defined or invalid

Идентификатор банковского реквизита не определен или имеет недопустимое значение

The RequisiteBankDetail with ID '357' is not found

Банковский реквизит с указанным идентификатором не найден

Access denied

Недостаточно прав доступа для получения банковского реквизита

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Изменить банковский реквизит
Следующая
Получить список банковских реквизитов по фильтру