ym88659208ym87991671
Справочники | Документация для разработчиков

Справочники

Обновлено 29 ноября 2024

Информация о сервисе

«Справочники» — это сервис, который позволяет вам получать различные справочники, данные из которых можно использовать в запросах API.


Варианты реализации

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

Сценарии описали общие, для более легкого восприятия информации описания работы с сервисом.

Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.

Варианты реализации
Получение справочника

Шаги

  1. Запросить справочник

Участники usecase

  • Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
  • Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предварительные условия

  • Запускается внутри одного из сценариев
  • У Платформы есть токены доступа Пользователя, полученные с помощью СберБизнес ID

Результат применения

  • Платформа получила справочник
Получение справочника

Используемые запросы

МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/dicts Получение справочникаDICT1. Запросить справочник
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Запросить справочник

Перечень справочников

Идентификатор справочника (name) / название справочника на русском языке

BIC / Справочник БИК
Наименование поляОписание поляПример
zipcode(String)Индекс109240
datech(Date)Дата контроля1970-01-01
address(String)Адресул Высоцкого, 4
city(String)ГородГ. Москва
corrAccount(String)Корр. счет30101810600000000754
tnp(String)Тип населенного пунктаГ
name(String)Наименование банкаКУ АО \"ЗЕРНОБАНК\"- ГК \"АСВ\"
type(String)Флаг «Участие в электронных расчетах» 0
bic(String)БИК банка040173754
cityOrig(String)Населенный пунктМосква
status(String)СтатусЛИКВ
ClearingStructure / Справочник структур национальных клиринговых кодов
Наименование поляОписание поляПример
countryCode(String)Код страныCH
countryIso(String)ISO код страныCH
countryNameRus(String)Наименование страны на русском языкеnull
format(String)Формат национального клирингового кода6!n
fullName(String)Наименование национального клирингового кодаSwiss Clearing Code (SIC code)
name(String)Сокращенное наименование национального клирингового кодаSwiss Clearing Code (SIC code)
note(String )Обозначение национального клирингового кодаSW
Country / Справочник стран
Наименование поляОписание поляПример
mnem03(String)3-символьный кодDZA
code(String)Цифровой код012
nameInt(String)Международное наименованиеALGERIA
mnem02(String)2-символьный кодDZ
name(String)НаименованиеАлжирская Народная Демократическая Республика
nameShort(String)Краткое наименование страныАЛЖИР
CurDict / Справочник валют
Наименование поляОписание поляПример
name(String)Наименование валютыАВСТРАЛИЙСКИЙ ДОЛЛАР
code(String)Код валюты (цифровой)036
isoCode(String)ISO код валютыAUD
fractDigits(Integer)Количество знаков дробных единиц в 1 целой единице2
DirType / Справочник типов списания
Наименование поляОписание поляПример
code(Integer)Код2
name(String)НаименованиеОплата товаров, работ, услуг по ценам (тарифам), подлежащим государственному регулированию
Instruction23 / Справочник кодов инструкций поля 23Е
Наименование поляОписание поляПример
compability(String)Не допускается совместное использование с кодамиCHQB,HOLD
code(String)КодSDVA
desc(String)ОписаниеСредства должны быть зачислены бенефициару той же датой валютирования
KeyWord70 / Справочник Кодовые слова поля 70
Наименование поляОписание поляПример
format(String)Формат[135!с]0!с
description(String)ОписаниеУказываются реквизиты счета-фактуры: дата, референс и детали через слэши ‘/’
codeWord(String)Кодовое слово/INV/
jurPersonUsage(String)Признак использования юр. лицами в ППY
KeyWord72 / Справочник Кодовые слова поля 72
Наименование поляОписание поляПример
format(String)Формат6..10n
description(String)ОписаниеМеждународный Блиц-перевод, осуществляемый только через счета Лоро ЦА
codeWord(String)Кодовое слово/IET/
currCode(String)Валюта111
jurPersonUsage(String)Признак использования юр. лицами в ППN
KeyWord77B / Справочник Кодовые слова поля 77B
Наименование поляОписание поляПример
format(String)Форматnull
description(String)ОписаниеУказывается код отчетности Национального банка Украины (НБУ) – используется только при переводе средств в UAH
codeWord(String)Кодовое слово/1PB/
currCode(String)ВалютаUAH
MzpCardType / Справочник типов пластиковых карт ЗП проект
Наименование поляОписание поляПример
bonusProgramCode(String)Код бонусной программыAE
depositTypeCode1C(String)Код вида вклада 1C50
typeName(String)Вид картыVisa Classic \"Аэрофлот\"
uniqueDesign(Boolean)Индивидуальный дизайнfalse
depositSubTypeCode1C(String)Код подвида вклада 1C2
peopleGroupName(String)Название категории населенияЗарплатная
typeCode(String)Код вида карты12
peopleGroupCode(String)Код категории населения207
ResidDict / Справочник Признак резидента оформившего ПС
Наименование поляОписание поляПример
code(String)Код0
description(String)Наименованиепризнак для ПС, оформленных до 01.10.2012
SalType / Справочник цифровых значений видов зачислений
Наименование поляОписание поляПример
description(String)ОписаниеПеревод по договору ГПХ
code(String)Цифровое значение49
SwiftBic / Международный справочник банков
Наименование поляОписание поляПример
zipZip код13022 KUWA
address(String)АдресOPPOSITE PUBLIC LIBRARY
bicInt(String)Международный БИКAAACKWKWXXX
filialName(String)Наименование филиалаBranch lxdMF
bicTypeNat(String)Тип национального БИКnull
countryNameShort(String)Краткое наименование страныСОЕДИНЕННЫЕ ШТАТЫ АМЕРИКИ
modflag(String)СтатусU
abonent(String)Тип абонентаnull
mnem03(String)3-символьный кодKWT
nationalId(String)Национальный клиринговый код50
bicNat(String)Национальный БИКnull
countryCode(String)Цифровой код414
mnem02(String)2-символьный кодKW
name(String)Наименование банкаALMUZAINI EXCHANGE COMPANY KSC (CLOSED)
location(String)Почтовый индекс, месторасположениеALKHOBAR
countryNameInt(String)Международное наименованиеKUWAIT
bicTypeInt(String)Тип международного БИКSWIFT
state(String)Республика/штатnull
place(String)Населенный пунктKUWAIT
account(String)Корсчет42013457689100142604
Templ70 / Справочник Шаблоны для поля 70
Наименование поляОписание поляПример
textRus1(String)Текст1null
textRus2(String)Текст2null
destination(String)Назначение платежа (англ.)ADVANCE PAYMENT FOR CONTRACT N
description(String)ОписаниеАВАНСОВЫЙ ПЛАТЕЖ ПО КОНТРАКТУ N
textRus3(String)Текст3null
textRus4(String)Текст3null
VOCodes / Справочник Коды видов валютных операций
Наименование поляОписание поляПример
description(String)Наименование вида валютной операцииПродажа резидентом иностранной валюты за валюту Российской Федерации
code(String)Код вида валютной операции01010
GenericLetterType / Справочник типов ПСФ
Наименование поляОписание поляПример
attachmentsEnabled(String)Признак возможности добавления обычных вложений0
attachmentsEnabledBF(String)Признак возможности добавления вложений с помощью сервиса Больших Файлов1
groupId(String)Порядковый номер группы письма для сортировки3
groupName(String)Наименование группы письмаОТОЗВАТЬ ПЛАТЕЖ, В Т.Ч. ИЗ КАРТОТЕКИ ИЛИ УТОЧНИТЬ РЕКВИЗИТЫ
letterType(String)Тип письмаОтзыв платежа из картотеки
sysGroupName(String)Системное имя группы письмаReqLetter
systemName(String)Системное имя типа письмаpayment_recall_from_register
template(String)Шаблон сообщения по умолчаниюПрошу ОТОЗВАТЬ ПЛАТЕЖ из КАРТОТЕКИ:____
LiborCode / Справочник кодов ставок ЛИБОР
Наименование поляОписание поляПример
description(String)Описаниемесячная ставка ЛИБОР
code(String)Код ставки LIBORЛ01
DocCode / Справочник кодов видов подтверждающих документов
Наименование поляОписание поляПример
description(String)Описание вида подтверждающего документаО вывозе с территории Российской Федерации товаров с оформлением декларации на товары или документов, указанных в подпункте 9.1.1 пункта 9.1 настоящей Инструкции, за исключением документов с кодом 03_3
code(String)Код вида подтверждающего документа01_4
PaymentPeriodCode / Код срока привлечения
Наименование поляОписание поляПример
description(String)Срок привлечения (предоставления)от 31 до 90 дней
code(String)Код срока1
DelDir / Признак поставки
Наименование поляОписание поляПример
description(String)Описание условия поставки валютыПредоставление резидентом коммерческого кредита нерезиденту в виде отсрочки оплаты
code(String)Код условия поставки валюты2
IBAN / Структура счетов IBAN/BBAN
Наименование поляОписание поляПример
flFormat(String)Описание условия поставки валютыПредоставление резидентом коммерческого кредита нерезиденту в виде отсрочки оплаты
ibnLen(String)Код условия поставки валюты22!c
bbnkr(String)Контрольное число1!n
bbnkrList(String)Контрольное число (список)
ibnFrm(String)Формат счета IBANTR 2!n 5!n 1!c 16!c
swiftPresence(Boolean )Флаг «есть/нет SWIFT-код в формате кода банка»true/false
ibnIsoBen(String)Список 2-буквенных кодов страны банка-бенефициараTR
ibnCodeBrn(String)Код филиала
ibnCodeBnk(String)Код банка5!n
ibnIso(String)2-буквенный код страныTR
ibnNum(String)Номер счета1!c 16!c
filialList(String)Код филиала (список)
ibnComment(String)Примечание3!n4!n-HEBIC-код
controlNumber(String)Контрольное число
BalAccInFrgnBanks / Балансовые счета получателей платежей в иностранных банках
Наименование поляОписание поляПример
balAcc(String)Номер счета (первые 5 знаков)30111
State / Справочник Административные единицы и штаты
Наименование поляОписание поляПример
fullName(String)Полное наименованиеAustralian Capital Territory
shortName(String)Сокращенное наименованиеА.С.Т.
isoCountry(String)2-буквенный код страныAU
CorpCardPaySystem / Справочник платежных систем
Наименование поляОписание поляПример
name(String)Платежная системаVisa
description(String)Описание платежной системыПлатежная система Visa
CorpCardType / Справочник типов бизнес-карт
Наименование поляОписание поляПример
typeName(String)Тип картыBusiness Digital
caption(String)Наименование типа картыЦифровая
firstYearTariff(String)Комиссия за первый год1000
afterFirstYearTariff(String)Комиссия за последующие года1 000 RUB / год
firstMonthTariff(Number)Комиссия за первый месяц100
afterFirstMonthTariff(String)Комиссия за последующие месяцы100 RUB / мес
receiveFromVsp(Boolean)Получение в ВСПtrue
description(String)Описание типа картыНастоящая карта, только без пластика. Выпуск онлайн - 5 минут.
CorpCardLimitType / Справочник типов лимитов бизнес-карт
Наименование поляОписание поляПример
code(String)Код лимитаT_MN_BUS
name(String)Наименование лимитаЛимит (Месяц) - все операции по карте
period(String)Период действия лимита: D - суточный, M - месячныйМ
maxValue(Number)Максимальное значение лимита50000
type(String)Тип картыVisa Business Travel
IssueAuthDict / Справочник подразделений выдавших паспорт
Наименование поляОписание поляПример
code(String)Код подразделения020-069
name(String)Наименование подразделенияОТДЕЛЕНИЕ УФМС РОССИИ ПО РЕСПУБЛИКЕ БАШКОРТОСТАН В ШАРАНСКОМ Р-НЕ
rating(Number)Рейтинг1
Subdivision / Справочник ВСП из NSI
Наименование поляОписание поляПример
terBank(String)Номер ТБ13
branch(String)Номер ОСБ9013
subBranch(String)Номер ВСП0165
name(String)Наименование структурного подразделенияВоронежское отделение №9013
address(String)Адресг.Воронеж, ул.9 Января, 28
code(String)Код структурного подразделения139013
sclir(String)Код подразделения0017-00167
fullName(String)Полное наименованиеДополнительный офис №8624/066 Пензенского отделения №8624 ПАО Сбербанк
email(String)Emailbranch@branch.ru
phone(String)Телефон8(495)353-16-78
defPhone(String)Телефон для юр.лиц8(495)351-56-78
workMode(String)Рабочее времяc 9:00 по 18:00
lng(Number)Долгота97,330107
lat(Number)Широта92,732103
branchId(Number)Идентификатор2983
index(String)Почтовый индекс117234
cashSymbol / Справочник кассовых символов
Наименование поляОписание поляПример
cashSymbol(String)Кассовый символ2
payCashSymbolName(String)Название кассового символа платежаПоступления от продажи товаров
SubdivisionCash / Справочник ВСП c услугой заказа наличных для ЮЛ
Наименование поляОписание поляПример
terBank(String)Номер ТБ13
branch(String)Номер ОСБ9013
subBranch(String)Номер ВСП0165
name(String)Наименование структурного подразделенияВоронежское отделение №9013
address(String)Адресг.Воронеж, ул.9 Января, 28
code(String)Код структурного подразделения139013
sclir(String)Код подразделения0017-00167
fullName(String)Полное наименованиеДополнительный офис №8624/066 Пензенского отделения №8624 ПАО Сбербанк
email(String)Emailbranch@branch.ru
phone(String)Телефон8(495)353-16-78
defPhone(String)Телефон для юр.лиц8(495)351-56-78
workMode(String)Рабочее времяc 9:00 по 18:00
lng(Number)Долгота97,330107
lat(Number)Широта92,732103
branchId(Number)Идентификатор2983
index(Number)Почтовый индекс117234
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.