Выплата на счет или карту Сбера
Откройте счет или выпустите карту Сбера, чтобы перечислять зарплату сотрудникам на них.
Обзор продукта
Общий перечень и порядок использования ресурсов SberAPI, относящихся к функциональности продукта.
Порядок использования
Перечень ресурсов
Используемые ресурсы SberAPI | Описание |
---|---|
/ic/sso/api/v2/oauth/token | 1. Авторизация пользователя. Токен доступа понадобится при обращении к API-запросам. Подробнее в разделе СберБизнес ID. |
/fintech/api/v1/salary-agreements | 2. Работа с зарплатными договорами: - получение информации о зарплатных договорах (потребуется при создании заявления на выплату). |
/fintech/api/v1/client-info | 2. Работа с информацией о компании: - получение информации о компании. |
/fintech/api/v1/dicts | 2. Работа со справочниками: - получение справочной информации. |
/fintech/api/v1/card-issues | 3. Управление открытием счетов и выпуском карт (реестром) 1: - подача заявления на открытие счетов и выпуск карт (создание реестра), - получение статуса реестра, - получение деталей реестра. |
/fintech/api/v1/payrolls | 4. Работа с выплатой по зарплатному проекту (зарплатной ведомостью)2: - подача заявления на выплату (создание ведомости), - получение статуса ведомости, - получение деталей ведомости. |
Варианты применения
Примеры состава и порядка исполнения запросов SberAPI в разных вариантах применения. Состав запросов может отличаться в зависимости от ваших бизнес-задач.
Выплата со счета в Сбере
Шаг | Запросы SberAPI | Код операции в scope |
---|---|---|
1 Получите токен доступа | POST /ic/sso/api/v2/oauth/token | openid |
2 Получите информацию по зарплатному договору | GET /fintech/api/v1/salary-agreements | SALARY_AGREEMENT |
3 Получите информацию о компании | GET /fintech/api/v1/client-info | GET_CLIENT_ACCOUNTS |
4 Получите информацию по типам пластиковых карт1 | GET /fintech/api/v1/dicts?name=MzpCardType | DICT |
5 Создайте реестр на открытие счетов и выпуск карт2 | GET /fintech/api/v1/card-issues/ | CARD_ISSUE |
6 Создайте зарплатную ведомость | POST /fintech/api/v1/payrolls | PAYROLL |
7 Получите статус зарплатной ведомости | GET /fintech/api/v1/payrolls/{externalId}/state | PAYROLL |
8 Получите детали зарплатной ведомости | GET /fintech/api/v1/payrolls/{externalId} | PAYROLL |
Участники
- Пользователь – сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа),
- Платформа – любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи,
- Sber API – запросы и ресурсы Sber API, к которым обращается Платформа.
Предварительные условия
Пользователь:
- имеет профиль в СберБизнес своей компании,
- находится в пространстве Платформы,
- прошел авторизацию с помощью СберБизнес ID.
Результат
- Создан и подписан платежный документ.
В этом варианте применения можно использовать подписание документа при помощи API-запроса. ЭЦП должна принадлежать сотруднику вашей компании. Подробнее...

При помощи платформы
Под платформой в данном разделе понимаем любую информационную систему партнера, предназначенную для предоставления финтех-услуг Сбера, отличную от ERP. Интеграция с помощью платформы отличается возможностью реализовать альтернативный сценарий подписания зарплатного реестра – переадресация пользователя на страницу зарплатного реестра в СберБизнес с последующим возвратом на Платформу.
Шаг | Запрос | Scope |
---|---|---|
1. Получите токен доступа | POST /ic/sso/api/v2/oauth/token | openid |
2. Получите информацию по зарплатному договору | GET /fintech/api/v1/salary-agreements | SALARY_AGREEMENT |
3. Получите информацию о счетах компании | GET /fintech/api/v1/client-info | GET_CLIENT_ACCOUNTS |
4. Создайте зарплатную ведомость | POST /fintech/api/v1/payrolls | PAYROLL |
5. Получите статус зарплатной ведомости | GET /fintech/api/v1/payrolls/{externalId}/state | PAYROLL |
6. Получите детали зарплатной ведомости | GET /fintech/api/v1/payrolls/{externalId} | PAYROLL |
Участники
- Пользовател ь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
- Сбербизнес - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
- Сторонний банк - любой другой банк, где у компании Пользователя есть расчетный счет
Предварительные условия
Пользователь:
- имеет профиль в СберБизнес своей компании,
- находится в пространстве Платформы,
- прошел авторизацию с помощью СберБизнес ID.
Результат
- Создан и подписан зарплатный реестр
Переадресация на зарплатный реестр
Для начала обработки зарплатного реестра Банком он должен быть подписан. При создании документа с помощью запроса API, документ также появляется в клиентской части СберБизнес Пользователя.
Можно облегчить пользовательский сценарий, если Пользователю сразу открыть упрощенный интерфейс СберБизнес только с данными зарплатного реестра. Для открытия упрощенного интерфейса СберБизнес потребуется сформировать ссылку и переадресовать по ней пользователя. Перейдя по ссылке на страницу зарплатного реестра, Пользователь пройдет аутентификацию и подпишет реестр. При успешном подписании сервис вернет Пользователя на вашу Платформу.
- Модель ссылки
- Пример
Ссылка переадресации выглядит следующим образом:
{контур Банка}/ic/ufs/payroll-light/index.html#/payroll-sign-and-send/{externalId}?backUrl={backUrl}
Переменная | Описание | Дополнительная информация |
---|---|---|
{контур Банка} | адрес Банка, на который делается запрос для открытия страницы сервиса оплаты | Для корректного выбора контура Банка потребуется определить тип криптопрофиля пользователя Клиента. В рамках запроса /ic/sso/api//v1/oauth/user-info вы получаете данные по Клиенту, в том числе атрибут userCryptoType.Атрибут позволяет определить криптопрофиль пользователя - SMS (СМС) или Token (электронный ключ (токен)). - Тестовый контур https://efs-sbbol-ift-web.testsbi.sberbank.ru:9443 - Промышленный контур СМС-пользователь https://sbi.sberbank.ru:9443 - Промышленный контур Токен-пользователь http://localhost:28016 |
{externalid} | уникальный идентификатор платежного документа | Данный идентификатор присваивает ваша Платформа на шаге создания черновика платежного поручения |
{backUrl} | страница возврата, на которую Банк вернет пользователя Клиента после успешного подписания черновика платежного поручения | - backUrl нужно закодировать URLEncode; - Если не указать backUrl в ссылке, пользователи не смогут после подписания платежного поручения вернуться на Платформу; - Если backUrl будет отличаться от адреса вашей платформы, который указали при регистрации в Банке, то при возврате клиента на backUrl он будет видеть ошибку. |
https://sbi.sberbank.ru:9443/ic/ufs/payroll-light/index.html#/payroll-sign-and-send/d4fbfe27-ee37-4451-b224-8113a06c44a3?backUrl=https://www.example.ru/
Схема работы с переадресацией в СББОЛ
- Графические описание
- Текстовое описание
Шаг | Действие | Подробности |
---|---|---|
1 | Авторизуйте Пользователя с помощью СберБизнес ID | Подробно о подключении и работе сервиса СберБизнес ID рассказали в соответствующем разделе документации. |
2 | Создайте зарплатный реестр в СберБизнес Пользователя | С помощью одного из предложенных ниже POST-запросов и access_token Пользователя Клиента вы создадите зарплатный реестр.Запрос: Создание реестра |
3 | Переадресуйте пользователя на страницу подписания зарплатного реестра | С использованием идентификатора созданного зарплатного реестра из шага №2 вы формируете ссылку для подписания/отправки и перенаправляете по ней пользователя Клиента. Перейдя по ссылке в сервис подписания/отправки, пользователь пройдет аутентификацию, подпишет зарплатный реестр для исполнения Банком. Ссылка переадресации:{контур Банка}/ic/ufs/payroll-light/index.html#/payroll-sign-and-send/{externalId}?backUrl={backUrl} |
4 | Проверьте статус и корректность зарплатного реестра в Сбербизнес | С помощью запроса вы сможете разработать механизм проверки статуса зарплатного реестра и реакцию Платформы на каждый из них. С помощью запроса вы сможете получить все параметры ранее созданного зарплатного реестра. Эту информацию можно использовать, например, в механизме проверки корректности зарплатного реестра. |
Шаг | Действия | Скрин |
---|---|---|
1 | Пользователь выбрал интересующий продукт и перешел к оплате. Вы предлагаете авторизоваться с помощью СберБизнес ID. | |
2 | Нажал на "Войти по СберБизнес ID" и попал на станицу аутентификации. | |
3 | После успешной аутентификации СберБизнес ID отображает данные по реестру и предлагает подписать его. Важно! Платформа ранее создала зарплатный реестр. | |
4 | Пользователь направил зарплатный реестр в банк после успешного подписания. | |
5 | Пользователь получил статус отправленного зарплатного реестра. |
Footnotes
-
Чтобы Сбер мог начать обрабатывать платежный документ сразу, он должен быть подписан электронной подписью уполномоченного сотрудника (имеющего право подписи от лица компании). Владелец токена доступа пользователя вашей компании должен совпадать с владельцем ЭП, которую будете использовать для подписания ведомости. Подробнее о работе с электронной подписью. ↩ ↩2
-
В случае, если хотите открыть зарплатный счет или карту в Сбере. ↩ ↩2