api/wallet/pay-out-sbp - СБП-выплата со счета Кошелька

HTTP‑метод: POST
URL: /api/wallet/pay-out-sbp
Форма взаимодействия: Сервер-сервер
Формат тела запроса: application/json
Назначение: проведение СБП-выплаты со счета Кошелька на базе ранее выполненного пречека.

URL

URLPATH

https://gateway-docs.wallet.kvell.group/api/wallet/pay-out-sbp

/api/wallet/pay-out-sbp

Структура запроса

Поле	Тип	Обяз.	Описание
`terminal`	`str`	✔	Уникальный идентификатор учетной записи ТСП в ПЦ.
`order_id`	`int`	✔	Уникальный идентификатор платежа (Заказа) в ПЦ, полученный по результатам запроса `api/register` или `pay-out-sbp-precheck`.
`precheck_tx_id`	`str`	✔	Уникальный идентификатор проверки возможности создания B2C перевода, полученный по результатам запроса `pay-out-sbp-precheck` (значение поля `precheck_tx_id` из его ответа).
`signature`	`str`	✔	Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.
`payer`	`object`	✔	Данные Кошелька-отправителя. Обязательно вложенное поле `wallet_public_id` (см. структуру payer/receiver). Если было объявлено, то ПЦ проверит, достаточно ли денежных средств для вывода с Кошелька на данный момент. Важно: параметр должен быть передан при регистрации заказа (`api/register`).
Необязательные параметры
`unique_key`	`str`		Ключ уникальности запроса. Генерируется на стороне ТСП. При получении ключа ПЦ выполняет проверку на наличие дубликата среди обрабатываемых запросов и созданных операций. Формат: допустимы цифры `[0-9]`, латинские буквы `[a-zA-Z]`, дефис и нижнее подчёркивание `[-_]`.

Структура ответа

Поле	Тип	Обяз.	Описание
`order_id`	`int`	✔	Идентификатор заказа в ПЦ. Пример: `1009982`
`order_status`	`str`	✔	Статус заказа. Пример: `REGISTERED`
`client_id`	`str`		Идентификатор пользователя ТСП. Пример: `test`
`tx_id`	`int`	✔	Идентификатор операции в ПЦ. Пример: `5587788`
`tx_completed_at`	`datetime`	✔	Дата и время совершения операции в ПЦ. Пример: `2024.01.28 00:23:19`
`tx_type`	`str`	✔	Тип операции. Пример: `P2PTRANSFER`
`tx_status`	`str`	✔	Статус операции. Пример: `APPROVED`
`tx_reason_code`	`int`	✔	Код ответа на операцию ПЦ. Пример: `1`
`message`	`str`		Краткое описание кода ответа на операцию ПЦ. Пример: `Successful financial transaction`
`amount`	`int`	✔	Сумма операции в минимальных единицах валюты. Пример: `100`
`fee`	`int`		Комиссия. Пример: `5000`
`currency`	`int`		Код валюты по ISO4217. Пример: `643`
`unique_key`	`str`		Ключ уникальности запроса. Пример: `test2`
`terminal_id`	`str`	✔	Уникальный идентификатор учётной записи ТСП в ПЦ. Пример: `893`
`phone`	`str`		Телефон Получателя. Пример: `70115110123`
`payment_system`	`str`	✔	Платёжная система. Пример: `2`
`multiple`	`str`		Признак мульти-операции. Пример: ``
`receiver_bank_id`	`str`		НСПК-идентификатор банка Получателя. Пример: `1crt88888881`
`external_id`	`str`		Внешний идентификатор операции. Пример: `B3072140714897010000147AD3F3F3FF`
`pam`	`str`		ФИО Получателя. Пример: `Петр Петрович П`
`signature`	`str`		Цифровая подпись сообщения.

Пример ответов

Успех (200)Пример ошибки (404)

{
    "order_id": 1009982,
    "order_status": "REGISTERED",
    "client_id": "test",
    "tx_id": 5587788,
    "tx_completed_at": "2024.01.28 00:23:19",
    "tx_type": "P2PTRANSFER",
    "tx_status": "APPROVED",
    "tx_reason_code": 1,
    "message": "Successful financial transaction",
    "amount": 100,
    "fee": 5000,
    "currency": 643,
    "unique_key": "test2",
    "terminal_id": "893",
    "phone": "70115110123",
    "payment_system": "2",
    "multiple": "",
    "receiver_bank_id": "1crt88888881",
    "external_id": "B3072140714897010000147AD3F3F3FF",
    "pam": "Петр Петрович П",
    "signature": "8f2a1c9e3b7d4056a1f8c2e9d3b6a70158fce29b4d7a1e6c0938fa2d17bc45e9"
}

{
    "error_code": "TERMINAL_NOT_FOUND",
    "technical_message": "Terminal not found",
    "timestamp": 1751976000,
    "details": null,
    "request_id": "b3b3c1f0-4b3a-4f3a-9b1a-1234567890ab"
}

Примечания

При получении запроса ПЦ проверяет:
Если в запросе передан параметр unique_key, то ПЦ проверяет запрос на наличие дубля;
Правильность расчета подписи и корректность параметров запроса;
Наличие разрешения терминала на использование сервиса;
Наличие на балансе Кошелька денежных средств в размере суммы значений параметров amount и fee, объявленных в Заказе с переданным order_id.