webapi/b2puser/sd-services/SDPayOutSBP - СБП-выплата со счета Кубышки
Описание
- HTTP‑метод:
POST
- URL:
/webapi/b2puser/sd-services/SDPayOutSBP/
- Форма взаимодействия: Сервер-сервер
- Формат тела запроса:
application/x-www-form-urlencoded
- Назначение: проведение СБП-выплаты со счета Кубышки на базе ранее выполненного пречека.
URL
Структура запроса
| Поле |
Тип |
Обяз. |
Описание |
sector |
str |
✔ |
Уникальный идентификатор учетной записи ТСП в ПЦ. |
id |
int |
✔ |
Уникальный идентификатор платежа (Заказа) в ПЦ, полученный по результатам запроса webapi/Register или SDPayOutSBPPrecheck. |
precheck_id |
str |
✔ |
Уникальный идентификатор проверки возможности создания B2C перевода, полученный по результатам запроса SDPayOutSBPPrecheck. |
signature |
str |
✔ |
Цифровая подпись. В формировании подписи участвуют параметры (если они использованы в запросе): sector, id, sd_ref, precheck_id, unique_key, password в указанном порядке. |
sd_ref |
str |
✔ |
Уникальный идентификатор Кубышки. Если был объявлен, то ПЦ проверит, достаточно ли денежных средств для вывода с Кубышки на данный момент. Важно: Параметр должен быть передан при регистрации заказа (webapi/Register). |
| Необязательные параметры |
unique_key |
str |
|
Ключ уникальности запроса. Генерируется на стороне ТСП. При получении ключа ПЦ выполняет проверку на наличие дубликата среди обрабатываемых запросов и созданных операций. Формат: допустимы цифры [0-9], латинские буквы [a-zA-Z], дефис и нижнее подчеркивание [-_]. Предупреждение: возможность использования ключа уникальности осуществляется по согласованию с Оператором. |
Структура ответа
| Элемент |
Тип |
Описание |
order_id |
int |
Идентификатор заказа в ПЦ. |
order_state |
str |
Статус заказа |
reference |
str |
Номер заказа на стороне ТСП. |
id |
int |
Идентификатор операции в ПЦ |
date |
datetime |
Дата и время совершения операции в ПЦ (YYYY.MM.DD HH:MM:SS). |
type |
str |
Тип операции. |
state |
str |
Статус операции |
reason_code |
int |
Код ответа на операцию ПЦ |
message |
str |
Краткое описание кода ответа на операцию ПЦ |
amount |
int |
Сумма заказа в минимальных единицах валюты (для RUB — копейки). |
fee |
int |
Сумма комиссии в минимальных единицах валюты (для RUB — копейки). |
curency |
int |
Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). |
approval_code |
str |
Код авторизации, полученный в Банке на данную операцию. |
unique_key |
str |
Ключ уникальности |
sector_id |
str |
Уникальный идентификатор учётной записи ТСП в ПЦ. |
phone |
str |
Телефон Получателя. |
ps |
str |
Платёжная система. Возможные значения параметра: 0 (по умолчанию) — не установлена; 1 — Visa; 2 — MasterCard; 8 — Maestro; 10 – MIR; 11 — СБП; 12 — Uzcard; 13 — JCB; 14 — оплата со счёта мобильного телефона; 16 — HUMO; 17 — CHUP. |
recipientBankId |
str |
НСПК идентификатор банка Получателя. |
externalId |
str |
Внешний идентификатор операции |
pam |
str |
ФИО Получателя. |
signature |
str |
Цифровая подпись сообщения. В подписи участвуют значения всех тегов в порядке их следования и пароль для расчёта цифровой подписи, предоставляемый ТСП после его регистрации в ПЦ. |
Пример ответов
Примечания
- При получении запроса ПЦ проверяет:
- Если в запросе передан параметр
unique_key, то ПЦ проверяет запрос на наличие дубля;
- Правильность расчета подписи и корректность параметров запроса;
- Наличие разрешения сектора на использование сервиса;
- Наличие на балансе Кубышки денежных средств в размере суммы значений параметров
amount и fee, объявленных в Заказе с переданным id.