В главное меню

Статус ссылки СБП


Описание

Метод позволяет получить актуальную информацию о оплате/привязке счета по выданной ранее ссылке СБП в рамках платежной сессии.

Входные параметры

Заголовок запроса

POST
Endpoint: https://sandbox.pay.mts.ru/private/invoice/status  HTTP/1.1
Content-Type: application/json
<Основные параметры>

Поле

Тип

Обяз.

Описание

Session-Id

string [32]

да

Идентификатор платежной сессии

Основные параметры

Поле

Тип

Обяз.

Описание

Request-IdguidдаИдентификатор конкретного запроса

Requestor-Name

string

нет

Наименование сервиса.

  • Для веба - домен, на котором запущен виджет.
  • Для SDK - идентификатор приложения.
  • Для API - имя вызывающей системы.
Requestor-Typestringнет

Тип витрины.

  • API
  • Web Widget
  • Web Page
  • SDK Apple
  • SDK Android
Requestor-VersionstringнетВерсия виджета/sdk

Выходные параметры

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

Поле

Тип

Обяз.

Описание

resultobjectнетСтруктура данных успешной операции
executionobjectнетСтруктура данных о процессе выполнения сценария

 

Unable to render {include} The included page could not be found.

Структура объекта execution

Поле

Тип

Обяз


recurrentPaymentToolExist

boolean

нет

Признак привязки рекуррентного инструмента

Пример

Заголовок запроса

POST https://sandbox.pay.mts.ru/private/invoice/status HTTP/1.1
Session-Id: d6946779-dd1a-4e91-8e21-e0ddc8a00288 
<Основные параметры> (пример в описании)

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

ответ (платеж проведен)

{
  "result": {
    "operationDate": "2020-12-28T07:40:29.870Z",
    "paymentId": 1234456,
    "paymentToolInfo": "СБП"
  }
}

ответ (платеж в процессе/сценарий не был начат пользователем)

{}

ответ (платеж отклонен)

{
  "requestId": "00000000-0000-0000-0000-000000000000",
  "code": "00100020",
  "userMessage": "Платеж по счету отклонен",
  "message": "Invoice payment declined",
  "isFatal": false,
  "isPublic": true
}

ответ (пользователь привязал счет, выполняется попытка списания)

{
  "execution": {
    "recurrentPaymentToolExist": true
  }
}

Возможные коды ошибок

code

message

userMessage

00199997Operation processing errorОшибка обработки операции
00199998Validation errorНе пройдена валидация данных
00199999An unexpected error has occurredНепредвиденная ошибка
00100001Session {0} not foundСессия не найдена