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

Изменение платежного инструмента


Введение

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

Операция доступна только для подписок в статусе:

Необходимо создать сессию и с полученным идентификатором (sessionId) начать работу с виджетом (полученную сессию Вы вставляете в ссылку вызова виджета - https://sandbox.pay.mts.ru/pages/pay?sessionId=полученная_сессия) , где клиент самостоятельно выберет платежный инструмент для существующей подписки.

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

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

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

Так же, передается SSL сертификат.

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

Поле

Тип

Обяз.

Описание

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

Requestor-Name

string

нет

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

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

Тип витрины.

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

Тело запроса

Поле

Тип

Обяз.

Описание

idguidдаИдентификатор подписки, уникальное текстовое значение
paymentToolsFilterobjectнетНабор инструкция для фильтрации ПМ/ПИ

Описание структуры paymentToolsFilter

Поле

Тип

Обяз.

Описание

allowedPaymentToolsarrayнет

Допустимые платежный инструмент

  • mtsBankCard  
  • boundCard 
  • mtsCharging    
  • mtsMobileCommerce    
  • extMobileCommerce    
  • sbp   
  • newСard  

allowedCardTypes

array

нет

Допустимые типы карт

  • VISA
  • MASTERCARD
  • MAESTRO
  • MIR
  • CUP

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

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

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

Тело ответа

Поле

Тип

Обяз.

Описание

sessionId

guid

да

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

Пример

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

POST /subscriptions/payment_tool/update/session/create HTTP/1.1
Host:
Content-Type: application/json
Request-Id: 8df44628-5fe8-40b8-8a2d-e214209a5cae

Тело запроса

{
  "id": "3417b9ff-6906-4ba1-b741-024d7cbfd8b4",
  "paymentToolsFilter": {
    "allowedPaymentTools": [
      "newСard",
      "sbp"
    ]
  }
}

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

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

Тело ответа

{
  "sessionId": "0b722ef4eb6b4cbe999e1c5bbcb4e456"
}

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

code

message

userMessage

00299998Validation errorНе пройдена валидация данных
00299999An unexpected error has occurredНепредвиденная ошибка
01000002Inactive merchantМерчант не активный
00200002Certificate is not validСертификат не прошел проверку
00200006Invalid operation for current subscription status: Current status: {0}Подписка в статусе, над которым данная операция запрещена
00200013The subscription {0} not found for merchant {1}Подписка не найдена
03000008Invalid operation for current subscription status: Current status: {0}В процессе проведения операции произошла ошибка. Попробуйте позже.