Skip to content

If you're interested in the English version of this spec, let us know on the GitHub.

bank


Подсказки по банкам

POST
/suggest/bank

Ищет кредитные организации:

  • по БИК,
  • SWIFT,
  • ИНН,
  • ИНН + КПП,
  • названию,
  • адресу до улицы.

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type
API Key (header: Authorization)

Request Body

application/json
object

Параметры запроса к API "Подсказки по банкам"

See https://dadata.ru/api/suggest/bank/
See https://confluence.hflabs.ru/pages/viewpage.action?pageId=262996078

Текст запроса.
@maxLength 300

Max Length300

Максимальное количество результатов.
@minimum 1
@maximum 20
@default 10

Minimum1
Maximum20
Default10
string[]

Ограничение по типу банка.
API принимает массив, например: "type": ["BANK", "BANK_BRANCH"]
https://confluence.hflabs.ru/pages/viewpage.action?pageId=262996122

Valid values"CBR""BANK""BANK_BRANCH""NKO""NKO_BRANCH""RKC""TREASURY""OTHER"
string[]

Ограничение по статусу банка.
API принимает массив, например: "status": ["LIQUIDATING"]
https://confluence.hflabs.ru/pages/viewpage.action?pageId=262996120

Valid values"ACTIVE""LIQUIDATED""LIQUIDATING"
object[]

Ограничение по региону или городу
API принимает массив вида { kladr_id: string }[]
https://confluence.hflabs.ru/pages/viewpage.action?pageId=527106238

object[]

Приоритет города при ранжировании.
API принимает массив вида { kladr_id: string }[]
https://confluence.hflabs.ru/pages/viewpage.action?pageId=527106242

Responses

Запрос успешно обработан

application/json
object

Объект с массивом подсказок

object[]
Required

Массив подсказок или пустой массив

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

  • Для банков (opf.type = BANK): краткое наименование (data.name.short).
    Если краткое наименование не указано — платежное наименование (data.name.payment).
  • Для всех остальных: платежное наименование (data.name.payment)

Наименование банка (то же, что и value)

object
Required

Подробности о банке

Playground

Server
Authorization
Body

Samples


Банк по БИК, SWIFT, ИНН или регистрационному номеру

POST
/findById/bank

Находит банк по любому из идентификаторов:

  • БИК,
  • SWIFT,
  • ИНН,
  • ИНН + КПП (для филиалов),
  • регистрационному номеру, присвоенному Банком России.
    Ищет только по точному совпадению, для частичного совпадения используйте метод suggest.

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type
API Key (header: Authorization)

Request Body

application/json
object

Любой из идентификаторов банка:

  • БИК,
  • SWIFT,
  • ИНН,
  • ИНН + КПП (для филиалов),
  • регистрационному номеру, присвоенному Банком России.

Ищет только по точному совпадению, для частичного совпадения
используйте API suggest (https://dadata.ru/api/suggest/bank/)

  • ИНН и КПП начиная с версиии подсказок 20.3+

Максимальное количество результатов
@default 10
@maximum 20

Default10
Maximum20

КПП банка

  • подсказки 20.3+

Responses

Запрос успешно обработан

application/json
object

Объект с массивом подсказок

object[]
Required

Массив подсказок или пустой массив

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

  • Для банков (opf.type = BANK): краткое наименование (data.name.short).
    Если краткое наименование не указано — платежное наименование (data.name.payment).
  • Для всех остальных: платежное наименование (data.name.payment)

Наименование банка (то же, что и value)

object
Required

Подробности о банке

Playground

Server
Authorization
Body

Samples


Powered by VitePress OpenAPI