Изменение подписки

Данный метод позволяет включить/отключить списание кешбека по всем следующим списаниям для конкретной подписки.

Статусы подписок, над которыми возможна данная операция: active.

В данный момент возможно только установка признака "списание кешбека"

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

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

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

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

Поле	Тип	Обяз.	Описание
Request-Id	guid	да	Идентификатор конкретного запроса
Requestor-Name	string	нет	Наименование сервиса. Для веба - домен, на котором запущен виджет. Для SDK - идентификатор приложения. Для API - имя вызывающей системы.
Requestor-Type	string	нет	Тип витрины. API Web Widget Web Page SDK Apple SDK Android
Requestor-Version	string	нет	Версия виджета/sdk

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

Параметр запроса

Поле	Тип	Обяз.	Описание
subscriptionId	guid	да	Идентификатор подписки, уникальное текстовое значение

Тело запроса

Метод будет позволять менять данные по подписке.

Поле	Тип	Обяз.	Описание
loyalty	object	нет	Данные о программе лояльности, которая была использована в платеже
amount	amount	нет	Сумма платежа >=0

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

Поле	Тип	Обяз.	Описание
type	string (enum)	нет	Тип программы лояльности. Пока тип только один - МТС Cashback mtsCashBack
isWithdrawalEnable	boolean	да	Признак выбора возможности списания Если передано true - тогда обязателен параметр type. Если передано false - тогда не обязателен параметр type. *как будет возможность начисления кешбека, а следовательно и передача параметра accruingEventCode - тогда дополнится логика.

Поле

Тип

Обяз.

Описание

type

string (enum)

нет

Тип программы лояльности. Пока тип только один - МТС Cashback

mtsCashBack

isWithdrawalEnable

boolean

да

Признак выбора возможности списания

Если передано true - тогда обязателен параметр type.
Если передано false - тогда не обязателен параметр type.
- *как будет возможность начисления кешбека, а следовательно и передача параметра accruingEventCode - тогда дополнится логика.

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

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

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

Пример

Запрос

Заголовок

POST https://sandbox.pay.mts.ru/private/v1/subscriptions/change/246da738-3947-408c-9d40-5c39ad16cc12 HTTP/1.1
Host:
Content-Type: application/json
<Основные параметры> (пример в описании)

Тело

{
  "loyalty": {
    "type": "mtsCashback",
    "isWithdrawalEnable": true
  }
}

Ответ

Заголовок

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

Тело

{}

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

Коды и описание представлено в таблице:

code	message	userMessage	isFatal
00299998	Validation error	Не пройдена валидация данных	нет
00299999	An unexpected error has occurred	Непредвиденная ошибка	да
01000001	Invalid certificate	Сертификат не прошел проверку	да
01000002	Inactive merchant	Мерчант не активный	да
00200011	Payments not available for service	Платежи не доступны для сервиса	да
00200013	The subscription {0} not found for merchant {1}	Подписка не найдена	да
00200022	Subscription not available for service	Подписки не доступны для сервиса	да
00200031	Loyalty program is not available for the service	Программа лояльности не доступна для сервиса	да
00200032	Error interacting with the loyalty system	Ошибка взаимодействия с системой лояльности	нет
00200033	The subscriber under this subscription is not registered in the loyalty system	Абонент по данной подписке не зарегистрирован в системе лояльности	да
00200034	The subscriber for this subscription is marked as a froder in the loyalty system	Абонент по данной подписке в системе лояльности отмечен как фродер	да
03000002	Subscription {0} not belong to merchant {1}	В процессе проведения операции произошла ошибка. Обратитесь в службу поддержки.	да
03000007	Subscription {0} not found	В процессе проведения операции произошла ошибка. Обратитесь в службу поддержки.	да
03000008	Invalid operation for current subscription status: Current status: {0}	В процессе проведения операции произошла ошибка. Попробуйте позже.	да