Общая информация и возможности
Версия API 1.8
API позволяет удобно и безопасно проводить выплаты, а также платить налоги.
Счет обеспечения выплат
Сначала вы передаете Банку 131 обеспечительный платеж, после этого Банк выполняет ваши распоряжения на выплаты. Сумма выплат не может превышать обеспечение, которое вы внесли.
Для выплат через Систему быстрых платежей (СБП) требуется открыть расчетный счет в Банке 131.
Вам необходимо регулярно проверять баланс счета обеспечения с помощью метода
wallet/balance
и заранее его пополнять — банковским
переводом на счет, который указан в договоре с Банком. Перевод идет от 1 до 3 рабочих дней.
Если сумма распоряжений на выплаты, которые вы отправляете по этому API, будет больше, чем обеспечительный платеж, Банк 131 не сможет провести выплаты.
Кому можно отправлять выплаты
Любым физическим и юридическим лицам, ИП и самозанятым.
При выплатах самозанятым необходимо сначала привязать самозанятого к Банку 131, а потом провести выплату с фискализацией по API.
Куда можно отправлять выплаты
- На российские банковские карты Visa, MasterCard, «Мир».
- На российские банковские счета.
- В кошельки ЮMoney (бывшие Яндекс.Деньги).
- В налоговую (ФНС).
Какие выплаты возможны
Кто может это делать
ИП и юридические лица, зарегистрированные в России и за ее пределами.
Что нужно для работы
Заключить договор с Банком 131, пройти идентификацию компании и провести интеграцию по этому API. С чего начать
Как получать данные карт для выплат
Если у вас есть сертификат PCI DSS, можно собирать данные банковских карт для выплат на вашей стороне. Если нет, можно использовать наш виджет: получатель выплаты вносит данные своей карты в виджете, вы получаете токен, по которому можно провести выплату на эту карту.
Также вы можете проводить выплаты по эквайринговым токенам.
Сквозной идентификатор карты
Для подключения этой функциональности, обратитесь к вашему менеджеру в Банке 131.
Если у вас нет PCI DSS, но нужно понимать, какую карту использует пользователь и есть ли пересечения между картами пользователей, вы можете использовать сквозной идентификатор карты.
Если у вас несколько проектов (
X-PARTNER-PROJECT
), сквозной идентификатор карты может быть одинаковым или разным для каждого. Сообщите вашему менеджеру в Банке 131, какая именно настройка нужна.
Сквозной идентификатор уникальный и формируется из значений номера карты и ее срока действия.
Его значение передается в новом параметре card_id
.
Сквозной идентификатор карты нельзя использовать для оплат или для получения всех привязанных карт.
Сквозной идентификатор не замена токена — вы будете получать их вместе.
Основной сценарий выплат
- С токеном
- Без токена
Отправьте запрос на создание токена для доступа к JavaScript-библиотеке.
Запустите виджет с созданным токеном и покажите его пользователю для получения данных карты в токенизированном виде.
Сохраните токенизированные данные карты, чтобы потом отправлять деньги на эту карту.
Отправьте выплату:
- (рекомендуется) создайте платежную сессию
session/create
, а затем инициируйте выплату с идентификатором этой сессии (session/start/payout
); или - создайте сессию одновременно с выплатой (
session/init/payout
).
В запросе на выплату передайте способ получения и все параметры, обязательные для этого способа.
- (рекомендуется) создайте платежную сессию
Дождитесь уведомления (
ready_to_confirm
) от Банка 131, что он готов провести выплату и ждет вашего подтверждения.Если у вас вебхуки отключены, отправьте запрос
session/status
и дождитесь, когда в полеsession.next_action
вернется значениеconfirm
.Подтвердите проведение выплаты (
session/confirm
) или отмените её (session/cancel
).Дождитесь от Банка 131 вебхука
payment_finished
со статусом выплаты. Статусsucceeded
означает, что выплата прошла успешно.
Отправьте выплату:
- (рекомендуется) создайте платежную сессию
session/create
, а затем инициируйте выплату с идентификатором этой сессии (session/start/payout
); или - создайте сессию одновременно с выплатой (
session/init/payout
).
В запросе на выплату передайте способ получения и все параметры, обязательные для этого способа.
- (рекомендуется) создайте платежную сессию
Дождитесь уведомления (
ready_to_confirm
) от Банка 131, что он готов провести выплату и ждет вашего подтверждения.Если у вас вебхуки отключены, отправьте запрос
session/status
и дождитесь, когда в полеsession.next_action
вернется значениеconfirm
.Подтвердите проведение выплаты (
session/confirm
) или отмените её (session/cancel
).Дождитесь от Банка 131 вебхука
payment_finished
со статусом выплаты. Статусsucceeded
сообщает вам, что выплата прошла успешно.
Выплата на счет в российском банке может вернуться в течение 5 дней. Тогда вам придет вебхук
payment_refunded
. Подробнее о возврате выплаты
Возврат выплат
При необходимости можно запросить возврат выплаты. Возврат выплат на счет происходит в течение 5 дней. Подробнее о возвратах выплат
Расчетный счет
Вы можете делать выплаты по API через СБП за счет средств на расчетном счете. Деньги мгновенно списываются с вашего расчетного счета и зачисляются на счет получателя. Пополнить расчетный счет вы можете банковским переводом.
Вы можете следить за балансом расчетного счета через интернет-банк, в выписке будут отражены все операции, как выплаты через СБП, так и любые другие операции по счету.
Номинальный счет
Вы можете осуществлять расчеты между плательщиками и получателями, используя номинальный счет. До момента зачисления денег на номинальный счет сообщите банку информацию о бенефициарах, которым принадлежат деньги.
При выплатах деньги мгновенно списываются с вашего номинального счета и зачисляются на карту получателя.
Вы можете следить за балансом номинального счета через интернет-банк, в выписке будут отражены все операции, как выплаты с номинального счета, так и любые другие операции по счету. Дополнительно банк пришлет реестр выплат, сделанных с помощью данного API.
Финансовые документы
Банк отправляет вам реестры о проведенных выплатах (каждый день) и акт (раз в месяц).
На каких условиях
Тарифы на выплаты фиксируются в договоре с Банком, их можно обсудить с менеджером. Лимиты зависят от способа выплат.