Backend разработчикам

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

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

Структура кодов ошибок

При работе по API могут быть получены ошибки, ниже представлена их структура.

Описание сообщения об ошибке

Пример

Тело ответа

{
  "requestId": "287fb7f4-26be-421b-898b-782915f58591",
  "code": "03400002",
  "message": "Объект не найден",
  "userMessage": "Объект не найден"
}

Дополнительная информация

ServiceParams 

ServiceParams передаются вместе с платежом для определения, за что конкретно был произведен платеж.
Если вы выполняете операцию пополнения счёта - serviceParams будут строго регламентированы.

Для определения serviceParams нужно предоставить информацию о реквизите оплаты (например, это может быть номер телефона МТС, лицевой счёт МТС Home и прочее). В случае операции оплаты - сервисные параметры помогут сопоставлять платеж с конкретной оплатой.

Рекомендуем использовать следующие базовые значения параметров:

Дополнительно сообщите нам на какой адрес отправлять уведомления о платежах и подписках. Если у вас пока нет адреса, то вы можете настроить его по отдельной заявке, когда будете готовы.

Привязанные карты и МТС Логин

Если необходимо дать клиенту возможность платежа с привязанных к профилю банковских карт (в том числе карт аккаунта МТС Банка, если он привязан к профилю), тогда для интеграции необходимо наличие валидного id_token МТС Логин, который генерируется в процессе аутентификации пользователя в интегрируемом приложении. Обязательным условием получения id_token является наличие значения openid в параметре scope URL авторизации МТС Логин (scope=openid). Этот id_token необходимо будет передавать при инициализации виджета в параметр с наименованием tokenId.

Адреса тестовых и продовых сервисов указаны в соответствующих разделах документации.

Информация по идентификаторам

• sessionId – уникальный идентификатор платежной сессии, получаем в ответе на создание платежной сессии. Используем при инициализации виджета;
• paymentId – уникальный идентификатор платежа, получаем при обработке уведомлений об успешном или неуспешном платеже. Используем при управлении платежами;
• subscriptionId - уникальный идентификатор регулярного списания, получаем при создании сессии на регулярное списание. Используем для управления регулярными платежами;
• paymentTokenId - уникальный идентификатор платежного токена, получаем в ответе при создании сессии с необходимостью создать платежного токена. Используем для управления платежным токеном.
• request-id – идентификатор запроса, получаем:
  • при выполнении вызова к сервису ПШ. Идентификатор (уникальный для каждого запроса) генерируется на стороне вызывающего сервиса;
  • при работе с виджетом, можно открыть код страницы, и для каждой операции виджета - идет передача этого параметра.