Информация о продукте
Зарплатный проект - это услуга, которая позволяет компаниям выплачивать заработную плату своим сотрудникам через банковские карты. СберБанк предоставляет полный спектр услуг по выпуску и обслуживанию зарплатных карт, а также осуществляет переводы денежных средств на карты сотрудников.
Подробнее о продукте на сайте.
С помощью API вы сможете легко интегрировать Зарплатный проект СберБанка в свою систему управления персоналом и автоматизировать процесс выплаты заработной платы. Это значительно упрощает работу HR-отдела компании и повышает эффективность процесса выплаты зарплаты.
Схема работы продукта
- Графическое описание
- Текстовое описание
| № | Что делаем | Подробности |
|---|---|---|
| 1 | Авторизуйте Пользователя с помощью СберБизнес ID | Подробно о подключении и работе сервиса СберБизнес ID рассказали в соответствующем разделе документации. |
| 2 | Получите информацию по зарплатному договору | С помощью ресурса /fintech/api/v1/salary-agreements и access_token пользователя получите информацию по зарплатному договору с Банком.Эта информация потребуется вам на следующем шаге при создании зарплатной ведомости для осуществления выплат. |
| 3 | Проведите выплату в рамках зарплатного проекта | С помощью ресурса /fintech/api/v1/payrolls и access_token пользователя создайте зарплатную ведомость.Чтобы Банк мог начать обрабатывать платежный документ сразу, он должен быть подписан электронной подписью уполномоченного сотрудника, имеющего право подписи от лица компании. Подробно о работе с электронной подписью рассказали в соответствующем разделе документации. Важно: Владелец access_token пользователя вашей компании должен совпадать с владельцем ЭП, которую будете использовать для подписания ведомости. |
| 4 | Проверьте статус и корректность оплаты | С помощью ресурса /fintech/api/v1/payrolls/{externalId}/state, access_token пользователя и идентификатора зарплатной ведомости (externalId) запросите статус зарплатной ведомости.При необходимости вы можете получить полные данные ранее отправленной зарплатной ведомости - вам потребуется ресурс /fintech/api/v1/payrolls/{externalId} |
Варианты реализации
Ниже будут приведены примеры реализации. Сценарии могут быть для вас отправной точкой и идеей для финального способа реализации функциональности.
Сценарии описали общие, для более легкого восприятия информации описания работы с продуктом Зарплатный проект в Sber API.
Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.
Выплата со счета в Сбере
В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании.
Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.
Шаги
- Получить информацию по зарплатному договору
- Провести выплату в рамках зарплатного проекта
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании
- Пользователь находится в пространстве Платформы
- Пользователь прошел авторизацию с помощью СберБизнес ID
Постусловия
- Создан и подписан платежный документ
Используемые запросы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 |  | /fintech/api/v1/client-info | Получение расширенной информации | GET_CLIENT_ACCOUNTS | 1. Получить информацию по зарплатному договору |
| 2 | | /fintech/api/v1/salary-agreements | Получение информации по договору | SALARY_AGREEMENT | 1. Получить информацию по зарплатному договору |
| 3 |  | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить информацию по зарплатному договору |
| 4 | | /fintech/api/v1/payrolls | Создание зарплатной ведомости | PAYROLL | 2. Провести выплату в рамках зарплатного проекта |
Выплата со счета в другом банке
В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании.
Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.
Шаги
- Получить информацию по зарплатному договору
- Провести выплату в рамках зарплатного проекта
Участники usecase
- Пользователь - сотрудник вашей компании либо представитель ЮЛ/ИП, от лица которого он работает в рамках вашего сервиса (Платформа)
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
- Сторонний банк - любой другой банк, где у компании Пользователя есть расчетный счет
Предусловия
- Пользователь имеет пользовательский профиль в СберБизнес своей компании;
- Пользователь находится в пространстве Платформы;
- Пользователь прошел авторизацию с помощью СберБизнес ID.
Постусловия
- Создан и подписан платежный документ
Используемые запросы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v1/client-info | Получение расширенной информации | GET_CLIENT_ACCOUNTS | 1. Получить информацию по зарплатному договору |
| 2 | | /fintech/api/v1/salary-agreements | Получение информации по договору | SALARY_AGREEMENT | 1. Получить информацию по зарплатному договору |
| 3 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить информацию по зарплатному договору |
| 4 | | /fintech/api/v1/payrolls | Создание зарплатной ведомости | PAYROLL | 2. Провести выплату в рамках зарплатного проекта |
Проверка статуса и корректности выплаты
Шаги
- Проверить статус выплаты
- Проверить корректность
Участники usecase
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Успешно выполнен сценарий "Выплата со счета в СберБанке" или "Выплата со счета в другом банке"
Постусловия
- Осуществлена выплата в рамках зарплатного проекта
- Проведена проверка корректности выплаты
Используемые запросы
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v1/payrolls/{externalId}/state | Получение статуса зарплатной ведомости | PAYROLL | 1. Получить статус выплаты |
| 2 | | /fintech/api/v1/payrolls/{externalId} | Получение полных данных по зарплатной ведомости | PAYROLL | 2. Проверить корректность |
| 3 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить статус выплаты |