Управление отложенной подпиской

Активация отложенной подписки

Введение

Данный сервис позволяет активировать подписку, если при создании был выбран isDelayed=true.

С текущей даты и времени + значения period и periodQuant - будет определена следующая дата списания.

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

onHold

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

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

POST
Endpoint: https://sandbox.pay.mts.ru/private/v1/subscriptions/unhold/{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

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

Поле	Тип	Обяз.	Описание
subscriptionId	guid	да	Идентификатор подписки, уникальное текстовое значение
Request-Id	guid	да	Идентификатор конкретного запроса, генерируется на стороне вызывающей системы

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

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

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

Тело ответа

Поле	Тип	Обяз.	Описание
status	string[32]	да	Статус подписки

Пример

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

POST https://sandbox.pay.mts.ru/private/v1/subscriptions/unhold/051f7a94-bfc0-432f-ae06-fd31c3ee50f8 HTTP/1.1
Host:
Content-Type: application/json
Request-Id: 8df44628-5fe8-40b8-8a2d-e214209a5cae

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

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

Тело ответа

{
  "status": "active"
}

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

code	message	userMessage
00299998	Validation error	Не пройдена валидация данных
00299999	An unexpected error has occurred	Непредвиденная ошибка
00200013	The subscription {0} not found for merchant {1}	Подписка не найдена
01000001	Invalid certificate	Сертификат не прошел проверку
01000002	Inactive merchant	Мерчант не активный
03000002	Subscription {0} not belong to merchant {1}	В процессе проведения операции произошла ошибка. Обратитесь в службу поддержки
03000007	Subscription {0} not found	В процессе проведения операции произошла ошибка. Обратитесь в службу поддержки
03000008	Invalid operation for current subscription status: Current status: {0}	В процессе проведения операции произошла ошибка. Попробуйте позже

Отмена подписки и возврат денежных средств за первый платеж

Введение

Данный метод позволяет отключить подписку и вернуть первую оплату, если при создании платежной сессии был выбран isDelayed=true, в структуре subscription.

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

onHold

Т.к. операция составная, то может быть выполнена только часть операции, а на второй операции возникала ошибка.

Сначала выполняется отключение/отмена подписки, потом запрос на возврат ДС:

если получаем код ошибки начинающийся на 030 - значит не смогли выполнить процесс отключения подписки;
если получаем код ошибки начинающийся на 020 - значит не смогли выполнить процесс возврата ДС.

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

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

POST
Endpoint: https://sandbox.pay.mts.ru/private/v1/subscriptions/cancel/{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

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

Поле	Тип	Обяз.	Описание
subscriptionId	guid	да	Идентификатор подписки, уникальное текстовое значение
Request-Id	guid	да	Идентификатор конкретного запроса, генерируется на стороне вызывающей системы

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

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

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

Тело ответа

{}

Пример

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

POST https://sandbox.pay.mts.ru/private/v1//subscriptions/cancel/051f7a94-bfc0-432f-ae06-fd31c3ee50f8 HTTP/1.1
Host:
Content-Type: application/json
Request-Id: 8df44628-5fe8-40b8-8a2d-e214209a5cae

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

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

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

code	message	userMessage
00299998	Validation error	Не пройдена валидация данных
00299999	An unexpected error has occurred	Непредвиденная ошибка
00200006	Invalid operation for current subscription status: Current status: {0}	Подписка в статусе, над которым данная операция запрещена
00200013	The subscription {0} not found for merchant {1}	Подписка не найдена
00200014	The subscription has no payment	Подписка не имеет ни одного платежа
00200015	Operation is not executed, the subscription has no sign "Delayed"	Операция не выполнена, подписка не имеет признака "отложенная"
00200016	Subscription more than one payment	Подписка имеет более одного платежа
00200017	Operation is not executed. The subscription is not disconnected, money is not returned	Операция не выполнена. Подписка не отключена, денежные средства не возвращены
00200018	Operation is executed partially. The subscription is disconnected, money is not returned	Операция выполнена частично. Подписка отключена, денежные средства не возвращены
01000001	Invalid certificate	Сертификат не прошел проверку
01000002	Inactive merchant	Мерчант не активный