Информация о продукте
Платежное поручение – это документ, который используется для указания банку перевести определенную сумму денег с одного счета на другой. Обычно это делается, когда компания хочет произвести оплату за товары или услуги, перевести деньги индивидуальному предпринимателю или юридическому лицу.
Платежные поручения используются широким кругом лиц, включая индивидуальных предпринимателей, малый и средний бизнес, крупные корпорации и даже государственные учреждения. Их используют, когда нужно сделать перевод, который требует предварительного уведомления или планирования (например, оплата аренды, коммунальных услуг или выплата заработной платы).
Больше полезной информации о расчетах и платежах можно изучить на сайте Банка .
Схема работы продукта
- Графическое описание
- Текстовое описание
| # | Что делаем | Подробности |
|---|---|---|
| 1 | Авторизуйте Пользователя с помощью СберБизнес ID | Подробно о подключении и работе сервиса СберБизнес ID рассказали в соответствующем разделе документации. |
| 2 | Получите реквизиты для формирования Платежного поручения | Запрос /fintech/api/v1/client-info и токен доступа (access_token) Пользователя позволит вам получить часть реквизитов для создания платежного поручения, в частности информацию о доступных счетах для списания денежных средств.Предоставьте Пользователю в UI вашей платформы заполнить реквизиты получателя платежа. Теперь у вас есть вся необходимая информация для создания платежного поручения. Можно переходить к следующему шагу. |
| 3 | Создайте и подпишите платежное поручение | Запрос /fintech/api/v1/payments и токен доступа (access_token) Пользователя позволит создать Платежное поручение в СберБизнес Пользователя.Если вместе с запросом передать ЭП к документу, то Банк сразу начнет обработку документа. У вас есть возможность автоматизировать подписание платежных документов в API - подробно о работе с ЭЦП рассказали в соответствующем разделе документации. Если запрос передать без ЭП к документу, в СберБизнес будет создан черновик Платежного поручения. Пользователю дополнительно потребуется перейти в UI СберБизнес и подписать документ. |
| 4 | Проверьте статус и корректность оплаты | С помощью запроса /fintech/api/v1/payments/{externalId}/state вы сможете разработать механизм проверки статуса оплаты и реакцию Платформы на каждый из них.С помощью запроса /fintech/api/v1/payments/{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 |  | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить реквизиты для формирования платежного поручения |
| 3 | | /fintech/api/v1/payments | Создание рублевого платежного поручения | PAY_DOC_RU | 2. Создать и подписать платежное поручение |
Время начала и частоту проверки статуса и корректности оплаты вы определяете самостоятельно исходя из своих бизнес-задач.
Шаги
- Получить статус оплаты,
- Проверить корректность
Участники usecase
- Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
- Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа
Предусловия
- Успешно выполнен сценарий "Осуществление перевода по расчетному счету"
- Платформа сохранила идентификатор (extertalId) платежного поручения, созданного в рамках сценария "Осуществление перевода по расчетному счету"
Постусловия
- Платежное поручение оплачено
- Проверена корректность ппроведенной оплаты
| № | Метод | Точка вызова | Описание | Операция в scope | Шаг в схеме |
|---|---|---|---|---|---|
| 1 | | /fintech/api/v1/payments/{externalId}/state | Получение статуса рублевого платежного поручения | PAY_DOC_RU | 1. Получить статус оплаты |
| 2 | | /ic/sso/api/v2/oauth/token | Обновление токена доступа | openid | 1. Получить статус оплаты |
| 3 | | /fintech/api/v1/payments/{externalId} | Получение платежного поручения | PAY_DOC_RU | 2. Проверить корректность |
Оплата за счет кредитных средств (РПП ЗКС)
1. Формирование платежного поручения
Для создания рублевого платежного поручения за счет кредитных средств (РПП ЗКС) через API необходимо передать в запросе дополнительные атрибуты:
isPaidByCredit: true # Признак оплаты за счет кредитных средств (обязательно при РПП ЗКС)
creditContractNumber: "2020/66556" # Номер кредитного договора
2. Дополнительное действие в СберБизнес
После успешного создания РПП ЗКС через API необходимо:
- Войти в СберБизнес
- К РПП ЗКС создать "Распоряжение о зачислении кредитных средств"
Без распоряжения платеж не будет исполнен.
Дополнительная информация
Назначение платежа
Назначение должно раскрывать экономический смысл платежа.
- Сведения должны быть лаконичными — у поля есть ограничения по знакам 210 символов.
- В назначении необходимо указать реквизиты документа, по которому вы осуществляете платеж, например, номер договора или счета.
- Рекомендуем указывать конкретный предмет оплаты.
- Если платеж с НДС, необходимо прописать точную сумму налога.
Ниже подробнее рассказали о формировании информации об НДС в назначении платежа.
Рекомендуемый вариант заполнения:
Оплата по договору [номер договора] от [дата договора]. НДС [ставка НДС]% - [сумма НДС] рубля [способ расчета НДС]. [Любая ваша информация]
Параметры НДС
Чтобы все работало правильно, нужно передать такие параметры:
- Если НДС (объект "vat") не передан в запросе, то будут использованы эти значения:
"vat": {
"type": "NO_VAT",
"rate": "0",
"amount": 0.00
}
В поле «type» можно выбрать одно из следующих значений:
ONTOP- НДС рассчитан по указанной ставке и добавляется к сумме платежа. Необходимо в поле "amount" (сумма платежа) указывать итоговую сумму оплаты (с учетом НДС).INCLUDED- НДС рассчитан по указанной ставке и включен в указанную сумму платежа. В поле «vat.amount» укажите сумму НДС. В поле «Назначение платежа» обязательно укажите посчитанную сумму НДС.MANUAL- Рассчитан и введен вручную (для сложных процентных ставок). Поле «vat.amount» заполнять необязательно, но по умолчанию сумма НДС будет равна нулю. Если же поле заполнено, то укажите нужную сумму НДС в соответствии с форматом.NO_VAT- НДС не облагается. В поле «Назначение платежа» обязательно укажите НДС не облагается.
Клиент вне зависимости от выбранного типа самостоятельно должен рассчитать конечную сумму к оплате и сумму НДС и ук азать эти значения в запросах. В поле "amount" (сумма платежа) указывается итоговая сумма платежа (с учетом НДС), в массиве "vat": поле amount указывается сумма НДС.
Пример заполнения: НДС 10% — 100.63 рубля или НДС 10%_100.63. Если процентное значение не указано, то дефис перед суммой ставить не нужно: НДС 100.63 рубля.