api/sbp/sbp-credit - B2C выплаты через СБП

HTTP‑метод: POST
URL: /api/sbp/sbp-credit
Форма взаимодействия: Сервер-сервер
Формат тела запроса: application/json
Назначение: выполнение перевода средств со счета ТСП на счет клиента через систему быстрых платежей.

URL

URLPATH

https://gateway-docs.prod.pay-pulse.com/api/sbp/sbp-credit

/api/sbp/sbp-credit

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

Поле	Тип	Обяз.	Описание
`terminal`	`str`	✔	Уникальный идентификатор учетной записи ТСП в ПЦ.
`order_id`	`int`	✔	Уникальный идентификатор платежа (Заказа) в ПЦ, полученный по результатам запроса api/register.
`precheck_tx_id`	`str`	✔	Уникальный идентификатор проверки возможности создания B2C перевода, полученный по результатам запроса api/sbp/sbp-credit-precheck.
`signature`	`str`	✔	Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.

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

Поле	Тип	Обяз.	Описание
`order_id`	`int`	✔	Идентификатор заказа в ПЦ. Пример: `1009982`
`order_status`	`str`	✔	Статус заказа. Пример: `REGISTERED`
`tx_id`	`int`	✔	Идентификатор операции в ПЦ. Пример: `5587788`
`tx_completed_at`	`datetime`	✔	Дата и время совершения операции в ПЦ (`YYYY.MM.DD HH:MM:SS`). Пример: `2024.01.28 00:23:19`
`tx_type`	`str`	✔	Тип операции. Пример: `P2PTRANSFER`
`client_id`	`str`		Номер заказа на стороне ТСП. Пример: `test`
`tx_status`	`str`	✔	Статус операции. Пример: `APPROVED`
`tx_reason_code`	`int`	✔	Код ответа на операцию ПЦ. Пример: `1`
`message`	`str`		Краткое описание кода ответа на операцию ПЦ. Пример: `Successful financial transaction`
`pam`	`str`		Имя Получателя денежных средств (ФИО-проверка через СБП). Возвращается только если для терминала включена соответствующая настройка на стороне провайдера — в остальных случаях `null`. Пример: `Петр Петрович П`
`phone`	`str`		Телефон Получателя денежных средств. Пример: `70115110123`
`receiver_bank_id`	`str`		Банк Получателя денежных средств. Пример: `100000000091`
`external_id`	`str`		Внешний идентификатор перевода в системе СБП. Пример: `B3072140714897010000147AD3F3F3FF`
`amount`	`int`	✔	Сумма заказа в минимальных единицах валюты (для RUB — копейки). Пример: `100`
`currency`	`int`		Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). Пример: `643`
`signature`	`str`		Цифровая подпись сообщения. Пример: `8f2a1c9e3b7d4056a1f8c2e9d3b6a70158fce29b4d7a1e6c0938fa2d17bc45e9`

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

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

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

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

Примечания

Ответ содержит поле external_id — внешний идентификатор перевода в системе СБП.
Ответ может содержать ряд необязательных параметров, которые важно учесть при составлении подписи.