Данный метод позволяет партнеру получить список подписок. Для фильтрации возвращаемых данных используются параметры запроса, описанные ниже.
Рекомендуется использовать передачу параметров:
либо:
При отсутствии этих параметров, вместе или по отдельности, то - время выполнения запроса, предоставление запрошенных данных, может занимать продолжительное время.
GET |
Так же, передается SSL сертификат.
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| Request-Id | guid | да | Идентификатор конкретного запроса |
Requestor-Name | string | нет | Наименование сервиса.
|
| Requestor-Type | string | нет | Тип витрины.
|
| Requestor-Version | string | нет | Версия виджета/sdk |
Поле | Обяз. | Описание | Комментарий |
|---|---|---|---|
extClientId | Нет | Идентификатор пользователя в системе Мерчанта | значение, полное совпадение |
clientPhone | Нет | Номер телефона указанный при создании подписки | значение, полное совпадение |
serviceId | Нет | Идентификатор услуги в каталоге ПЦ ЭК | значение, полное совпадение |
merchantMnemonic | Нет | Наименование подписки в системе Мерчанта | ищет по подстроке |
Id | Нет | subscriptionId - Идентификатор подписки, уникальное текстовое значение | значение, полное совпадение |
amountMore | Нет | Сумма списания, нижняя граница | значение |
amountLess | Нет | Сумма списания, верхняя граница | значение |
startDateAfter | Нет | Дата начала подписки, от | значение |
startDateBefore | Нет | Дата начала подписки, до | значение |
endDateAfter | Нет | Дата окончания подписки, от | значение |
endDateBefore | Нет | Дата окончания подписки, до | значение |
createdAtAfter | Нет | Дата создания подписки, от | значение |
createdAtBefore | Нет | Дата создания подписки, до | значение |
status | Нет | Статус подписки | перечисление |
Content-Type: application/json; charset=utf-8 |
Поле | Тип | Описание |
|---|---|---|
id | guid | Идентификатор подписки |
serviceId | int64 | Идентификатор сервиса Мерчанта |
extClientId | string[32] | Идентификатор пользователя в системе Мерчанта |
clientPhone | string[15] | Номер телефона пользователя |
string[512] | Адрес почтового ящика пользователя | |
merchantMnemonic | string[512] | Наименование подписки на стороне Мерчанта |
userMnemonic | string[512] | Наименование подписки на стороне Пользователя |
amount | amount | Сумма списания по подписке |
currency | string[3] | Валюта, по умолчанию 643 |
serviceParams{} | object | Набор пар "параметр":"значение", описывающих реквизиты платежа (специфичных для каждого поставщика) |
| status | string | Статус подписки |
startDate | dateTime | Дата и время начала подписки |
endDate | dateTime | Дата и время окончания подписки |
period | int32[3] | Периодичность списания |
periodQuant | string | Единицы периода списания, может принимать значения "day", "week", "month" |
paymentTool | object | Структура с данными по источнику оплаты |
nextPaymentDate | dateTime | Дата и время следующего списания |
| lastPaymentDate | dateTime | Дата и время последнего списания |
trialPeriod | int32[3] | Количество дней триального периода |
isDelayed | boolean | Признак отложенной активации подписки, по умолчанию false |
| failedAttemptsQty | int32 | Количество неуспешных попыток оплаты |
createdAt | dateTime | Дата создания записи |
updatedAt | dateTime | Дата изменения записи |
description | string[512] | Краткое описание подписки. Для экосистемных продуктов оно будет выведено как описание подписки на витрине Мой МТС в разделе подписок |
promo | object | Набор параметров отвечающих за промо период подписки |
loyalty | object | Структура с данными по программе лояльности |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
amount | amount | да | сумма при списании в течение промо периода |
durationType | durationTypeEnum | да | Тип учета промо, quant или date |
period | int34 | условно | Кол-во периодов, в течении которого списывается промо сумма |
execPeriod | int34 | условно | Счетчик успешно проведенных платежей с промо периодом, в связке с period |
endDate | dateTime | условно | Дата окончания промо периода |
Поле | Тип | Обяз. | Описание | Пример |
|---|---|---|---|---|
| ewalletBinding | object | нет | Оплата с электронного кошелька ПЦ | "ewalletBinding": {
"bindingId": "1147849C95D145B196878C93922C3FFF",
"title": "MasterCard *8146",
"bindingType": "BOUND_CARD",
"card": {
"type": "MIR",
"maskedPan": "224410******1804",
"expiryYear": 7,
"expiryMonth": 2023 |
chargingEP | object | нет | Структура с параметрами оплаты, через сервис EP.Charging | "chargingEp": {
"phone": "79685310245",
"maskedPhone": "7968**45",
"serviceCode": "151D",
"title": "mtsCharging" |
internalBinding | object | нет | Объект с данными карты привязанной в хранилище МТС Pay | "internalBinding": {
"internalBindingId": "d4d186d9-8483-485b-bc8f-62019cfcee7f" |
| sbpToken | object | нет | Оплата через сервис быстрых платежей, сервис Invocing | "sbpToken": { |
| extMobileCommerce | object | нет | Оплата ЛС внешней мобильной коммерции | "extMobileCommerce": {
"phone": "79999999999"
} |
| sberPay | object | нет | Оплата через приложение sberPay | "sberPay": {} |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
bindingId | string | да | Идентификатор счета/токена |
title | string | нет | Наименование платежного инструмента (для витрин) |
| bindingType | string | нет | Тип платежного инструмента кошелька МТС Деньги |
| maskedPhone | string | нет | Маскированный номер телефона для вывода на витрины. Доступно для для bindingType = MTS_ACCOUNT |
| card | object | нет | Структура данных карты (для bindingType = BOUND_CARD, GENERAL_CARD) Необязательный, т.к. по старым данным - может отсутствовать. |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
phone | string | да | Номер телефона |
| maskedPhone | string | нет | Маскированный номер телефона для вывода на витрины. Необязательный, т.к. по старым данным - может отсутствовать. |
serviceCode | string[30] | да | Код продукта в системе Foris, за который производится оплата |
title | string | нет | Наименование платежного инструмента (для витрин) |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
internalBindingId | guid | да | Идентификатор карты во внутреннем хранилище |
title | string | нет | Наименование платежного инструмента (для витрин) |
| card | object | да | Структура данных карты |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| id | int64 | нет (обязателен для инфо по токену | Идентификатор карты
|
| type | string | да | Тип платежной системы (VISA, MASTERCARD, MAESTRO, MIR, CUP и др.) |
maskedPan | string | да | Маскированный номер карты |
expiryMonth | int32[2] | да | Месяц действия карты (MM) |
| expiryYear | int32[4] | да | Год действия карты (YYYY) |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| accountNumber | string | да | Номер счет |
| id | int64 | да | Идентификатор токена СБП |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
phone | msisdn | да | Номер телефона (MSISND) |
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
пустой объект | |||
Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| type | string (enum) | да | Тип программы лояльности. Пока тип только один - МТС Cashback
|
repaymentRatio | decimal | нет | Максимальная часть стоимости покупки, которая может быть списана со счета кэшбэка. Наличие данного признака указывает на включенный списания кэшбэка по данной подписке |
GET https://sandbox.pay.mts.ru/private/v1/subscriptions?phone=79160026188 HTTP/1.1 |
Content-Type: application/json; charset=utf-8 |
[
{
"id": "325f2e49-dc57-4204-a136-52965118b562",
"serviceId": 6340,
"clientPhone": "79160026188",
"extClientId": "d6946779-dd1a-4e91-8e21-e0ddc8a00288",
"eWalletUserId": "00000000100025970633",
"merchantMnemonic": "puck",
"userMnemonic": "troldol",
"serviceParams": {
"id1": "108882256562"
},
"status": "active",
"startDate": "2021-02-17T00:00:00Z",
"endDate": "2021-12-20T00:00:00Z",
"nextPaymentDate": "2021-03-22T00:00:00Z",
"createdAt": "2021-03-22T11:07:52.586743Z",
"updatedAt": "2021-03-26T12:45:01.969452Z",
"period": 1,
"periodQuant": "day",
"amount": 1000.00000,
"currency": "643",
"smsConfirm": false,
"paymentTool": {
"eWalletBinding": {
"bindingId": "2147849C95D145B196878C93922C3FFF"
}
}
},
{
"id": "213de855-7908-41a5-98d4-feef322776cb",
"serviceId": 6340,
"clientPhone": "79160026188",
"extClientId": "d6946779-dd1a-4e91-8e21-e0ddc8a002665",
"eWalletUserId": "00000000100025972205",
"merchantMnemonic": "test19012021",
"userMnemonic": "test19012021",
"serviceParams": {
"NUMBER": "79175289685",
"payerEmail": "atasimov@mts.ru",
"id1": "108882256562"
},
"status": "active",
"startDate": "2021-03-09T03:06:16Z",
"nextPaymentDate": "2021-03-27T00:00:00Z",
"createdAt": "2021-03-26T10:17:06.476991Z",
"updatedAt": "2021-03-26T10:17:18.875626Z",
"period": 1,
"periodQuant": "day",
"trialPeriod": 0,
"amount": 10.00000,
"currency": "643",
"smsConfirm": false,
"paymentTool": {
"eWalletBinding": {
"bindingId": "1147849C95D145B196878C93922C3FFF"
}
},
"loyalty": {
"type": "MTSCashBack",
"repaymentRatio": 0.25
}
"promo": {
"amount": 5.00000,
"durationType": "quant",
"period": 2,
"execPeriod": 0
}
}
]
[
{
"id": "325f2e49-dc57-4204-a136-52965118b562",
"serviceId": 6340,
"clientPhone": "79160026188",
"extClientId": "d6946779-dd1a-4e91-8e21-e0ddc8a00288",
"eWalletUserId": "00000000100025970633",
"merchantMnemonic": "puck",
"userMnemonic": "troldol",
"serviceParams": {
"id1": "108882256562"
},
"status": "active",
"startDate": "2021-02-17T00:00:00Z",
"endDate": "2021-12-20T00:00:00Z",
"nextPaymentDate": "2021-03-22T00:00:00Z",
"createdAt": "2021-03-22T11:07:52.586743Z",
"updatedAt": "2021-03-26T12:45:01.969452Z",
"period": 1,
"periodQuant": "day",
"amount": 1000.00000,
"currency": "643",
"smsConfirm": false,
"paymentTool": {
"eWalletBinding": {
"bindingId": "1147849C95D145B196878C93922C3FFF"
}
}
]
Возможные коды ошибок
code | message | userMessage |
|---|---|---|
00299998 | Validation error | Не пройдена валидация данных |
00299999 | An unexpected error has occurred | Непредвиденная ошибка |
01000001 | Invalid certificate | Сертификат не прошел проверку |
01000002 | Inactive merchant | Мерчант не активный |