Поиск банковских реквизитов

POST /v1/bank-details/search

Поиск банковских реквизитов с фильтрами и авто-пагинацией. Аналогичен GET /v1/bank-details, но параметры передаются в теле запроса — подходит для сложных фильтров с большим количеством условий и для программной сборки запросов.

Поля запроса (body)

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/bank-details/fields.
Синтаксис фильтрации. Пример: { "entityId": 3, "active": true }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
order object — Сортировка: { "id": "desc" }
select string[] — Выборка полей: ["id", "name", "rqBik", "rqAccNum"]

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/bank-details/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": 3, "active": true },
    "limit": 20,
    "order": { "id": "asc" }
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/bank-details/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityId": 3, "active": true },
    "limit": 20,
    "order": { "id": "asc" }
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 3, active: true },
    limit: 20,
    order: { id: 'asc' },
  }),
})

const { success, data } = await res.json()
console.log('Найдено:', data.length)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bank-details/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityId: 3, active: true },
    limit: 20,
    order: { id: 'asc' },
  }),
})

const { success, data } = await res.json()

Другие сценарии

Все банковские реквизиты одного реквизита:

JSON 
{ "filter": { "entityId": 11 } }

Фильтр по БИК:

JSON 
{ "filter": { "rqBik": "13142323452" } }

С выборкой конкретных полей:

JSON 
{
  "filter": { "active": true },
  "select": ["id", "entityId", "name", "rqBik", "rqAccNum"],
  "order": { "id": "asc" }
}

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив банковских реквизитов (все поля — см. Поля банковского реквизита)
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityId": 3,
      "countryId": 1,
      "name": "Банковские реквизиты 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "Реквизиты 1",
      "rqBankAddr": null,
      "rqBik": null,
      "rqAccNum": null,
      "rqCorAccNum": null,
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-05-22T11:56:53.000Z",
      "updatedAt": "2023-12-05T11:50:19.000Z",
      "createdBy": 1,
      "modifyBy": 779
    },
    {
      "id": 5,
      "entityId": 11,
      "countryId": 1,
      "name": "Банковские реквизиты 1",
      "active": true,
      "sort": 500,
      "code": null,
      "xmlId": null,
      "rqBankName": "банк",
      "rqBankAddr": "тестовый адрес",
      "rqBik": "13142323452",
      "rqAccNum": "234245746878032451534",
      "rqCorAccNum": "235134524566748725431",
      "rqSwift": null,
      "rqIban": null,
      "createdAt": "2020-06-30T09:53:58.000Z",
      "updatedAt": null,
      "createdBy": 1,
      "modifyBy": null
    }
  ],
  "meta": {
    "total": 6,
    "hasMore": true
  }
}

Пример ответа при ошибке

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 INVALID_FILTER Ошибка в синтаксисе фильтра

Полный список общих ошибок API — Ошибки.

Известные особенности

entityTypeId не возвращается в ответе. Это поле передаётся только при создании. В ответах поиска поле отсутствует — фильтровать по entityId (ID реквизита-владельца).

Пагинация. При limit > 50 запрос автоматически разбивается на несколько вызовов к Битрикс24. Для больших выборок используйте offset и постраничные запросы.

Смотрите также