Получить представление пакетной подписки владельца по идентификатору подписки совладельца
/info/subscriptions/byChildId
Получить представление пакетной подписки владельца по идентификатору подписки совладельца
Запрос
Header Parameters
Возможные значения: <= 32 characters
, Value must match regular expression ^[0-9a-fA-F]{32}$
Уникальный идентификатор запроса
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней системы
Значение должно соответствов ать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней подсистемы
Значение должно соответствовать регулярному выражению ^([0-9a-zA-Zа-яА-ЯеЁ]|\s|-){1,100}$
Значение должно соответствовать регулярному выражению ^([0-9a-zA-Zа-яА-ЯеЁ]|\s|-){1,200}$
- application/json
Body
required
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор подписки
fillParameters
object
Параметры наполнения представления подписки
Указатель на заполнение представления подписки перечнем мультикатегорий пакета по дписки (При отсутствии заполнение не производится)
Указатель на заполнение представления подписки перечнем периодов оплаты срока действия подписки (При отсутствии заполнение не производится)
Указатель на заполнение представления подписки перечнем статусов услуг в подписке (При отсутствии заполнение не производится)
Указатель на заполнение представления подписки перечнем операций над подпиской (При отсутствии заполнение не производится)
Указатель на заполнение представления подписки перечнем приглашений к пакетной подписке (При отсутствии заполнение не производится)
screenFormCriteria
object
Точки входа в сегментацию персональной витрины клиента
Значение должно соответствовать регулярно му выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Точка входа в категории
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Точка входа в экранные формы
OK
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор
Возможные значения: [SBER_ID
, EPC_RB_ID
, EPC_CB_ID
, ERIB_ID
, MDM_ID
, DIALOG_ID
, MOBILE_PHONE
, EMAIL
, ESIA_ID
, SUB
, CRM_ID
, CRM_ID_NO_CLIENT
]
Тип внешнего идентификатора потребителя (По умолчанию SUB)
Значение должно соответствовать регулярному выражению ^[A-Fa-f0-9]{16,100}$
Внешний идентификатор клиента (Примечание: Допускается конвертация значения данного поля шлюзом интеграции при keyType = SUB)
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время создания
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор пакета
Возможные значения: [TRIAL_PERIOD_ENABLED
, TRIAL_PERIOD_ENABLED_BUT_STILL_IN_USE
, TRIAL_PERIOD_ENABLED_BUT_WAS_USAGE
, TRIAL_PERIOD_NOT_ENABLED
]
Доступность использования одного из условий пробного периода
Признак внешнего управления параметрами подписки
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор экранной формы в каталоге для построения экрана кли енту в разрезе канала
ПРИМЕЧАНИЕ:
для обратной совместимости или случаев не штатно-аварийного функционирования значение может быть 00000000-0000-0000-0000-0000000000 и указывает на то, что экранная форма отсутствует в каталоге или поисковый запрос был построен в целях формирования служебного (не клиентского) экрана.
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя
Значение должно соотве тствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,100}$
Отображаемое имя статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Интегральный статус
Возможные значения: <= 50 characters
, Value must match regular expression ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Корневой идентификатор пакета документов
Возможные значения: >= 0
и <= 1000000
Расчетная цена при очередном продлении
Возможные значения: >= 0
и <= 1000000
Расчетное количество минимальных живых денег в сумме рекурентного платежа
ПРИМЕЧАНИЕ:
на MVP установлено не более 1000000.
Возможные значения: >= 0
и <= 1000000
Расчетное количество баллов лояльности в сумме рекурентного платежа
ПРИМЕЧАНИЕ:
на MVP установлено не более 1000000
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
Срок начала приостановки оплаченного периода потребителем
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
Срок окончания оплаченного триал периода потребителем
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
Дата окончания оплаченного периода
Флаг унитарности
Флаг рекуррентности
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время очередной рекурентнной оплаты
Флаг доступности использования установленного потребителем процента лояльности от суммы разрешенной владельцем пакета для оплаты баллами лояльности в рекурентном платеже, если они будут доступны
Возможные значения: >= 0
и <= 100
Процент потребителя от суммы разрешенной владельцем пакета для оплаты баллами лояльности в рекурентном платеже, если они будут доступны
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
Дата окончания срока действия грейс периода
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
Дата окончания срока действия приостановленного периода
Флаг ожидания активации услуги потребителем
payToolInfo
object
Параметры платежа совершенного через платежный инструмент потребителя достаточные для выполнения рекуррентного платежа в платежной системе
Возможные значения: [NONE
, EPS
, RBS
, SBER_PAY
, PAYQR
, GOOGLE_PAY
, APPLE_PAY
, KSH_KZ
, SM_BY
, OKKO_ANS
, OKKO_SBER
, OKKO_UKASSA
, OKKO_UCS
, OKKO_PSCB
, OKKO_RSB
, OKKO_SMS
, OKKO_WALLET_ONE
, ASSIST_RU
, ASSIST_BY
, ELCOM_D
, ELCOM_W
, CLC
, ECOM
, ECOM24
, ELCOM_D24
]
Тип платежной системы
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-]{1,100}$
Уникальный идентификатор счета потребителя в платежной системе, представление номера платежного инструмента или связки с ним:
Для paySystemType:
EPS – null;
RBS – идентификатор связки (bindingId);
ASSIST_BY – идентификатор связки (bindingId);
ASSIST_RU – идентификатор связки (bindingId);
SM_BY – представление платежного инструмента - обязателен для указания;
KSH_KZ – представление платежного инструмента - обязателен для указания;
SBER_PAY – идентификатор счета в банке (BankInvoiceId);
CLC - идентификатор DPAN - обязателен для указания;
ELCOM_D - идентификатор DPAN - обязателен для указания;
ELCOM_W - идентификатор кошелька - обязателен для указания.
ПРИМЕЧАНИЕ:
поле может не совпадать со значением payAuthInfo.paySystemInvoiceId
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\- ]{1,255}$
Идентификатор мерчанта в платежной системе
ПРИМЕЧАНИЕ:
поле обязательно, если платеж был начат в адрес paySystemType SBER_PAY.
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\- ]{1,255}$
Идентификатор терминала в платежной системе
ПРИМЕЧАНИЕ:
поле обязательно, если платеж был начат в адрес paySystemType SBER_PAY.
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,10}$
Система платежного инструмента потребителя
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z\\*]{1,20}$
Маскированное представление платежного инструмента потребителя
Значение должно соответствовать регулярному выражению ^[0-9]{1,6}$
Год месяц окончания срока действия платежного инструмента потребителя
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Наименование банка платежного инструмента потребителя
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-]{1,36}$
Идентификатор авторизующей транзакции, RRN или иной уникальный идентификатор связки с результатами операции
ПРИМЕЧАНИЕ:
поле обязательно для успешной операции оплаты одностадийного платежа или успешной последней фазы многостадийного
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\- ]{1,36}$
Код авторизации
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время авторизации операции
ПРИМЕЧАНИЕ:
поле обязательно для успешной операции оплаты одностадийного платежа или успешной последней фазы многостадийного
location
object
Параметры геопозиции
Возможные значения: >= -180
и <= 180
Широта геопозици
Возможные значения: >= -90
и <= 90
Долгота геопозици
serviceOptions
object
Представление подключенных и предлагаемых опциональных услуг
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор группировки экранных формы опциональных услуг подписки в каталоге для построения экрана клиенту в разрезе канала
ПРИМЕЧАНИЕ:
для обратной совместимости или случаев не штатно-аварийного функционирования значение может быть 00000000-0000-0000-0000-0000000000 и указывает на то, что экранная форма отсутствует в каталоге или поисковый запрос был построен в целях формирования служебного (не клиентского) экрана.
availableServiceOptions
object[]
Possible values: <= 200
Перечень подключенных опциональных услуг
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор опциональной услуги
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время добавления к подписке
Возможные значения: >= 0
и <= 1000000
Стоимость использования
Возможные значения: >= 0
и <= 1000000
Расчетная стоимость использования (часть стоимости следующего рекурентного продления)
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время прекращения срока действия при отказе клиентом от дальнейшего использования
suggestedServiceOptions
object[]
Possible values: <= 200
Перечень доступных для подключения опциональных услуг
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор опциональной услуги
Возможные значения: >= 0
и <= 1000000
Стоимость использования
Возможные значения: >= 0
и <= 1000000
Расчетная стоимость использования (часть стоимости следующего рекурентного продления или стоимости первичной оплаты)
Возможные значения: <= 100
Перечень идентификаторов взаимоисключающих опциональных услуг
categories
object
Представление категории на каталогизируемом владельце
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя корневой категории
Возможные значения: <= 1024 characters
, Value must match regular expression ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Пиктограмма корневой категории
categoryGroups
object
Корневая группа категорий
groups
object[]
required
Possible values: <= 100
Список групп категорий
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя группы категорий
categories
object[]
Possible values: <= 100
Список категорий
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя категории
Возможные значения: <= 1024 characters
, Value must match regular expression ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Пиктограмма
subCategories
object[]
Possible values: <= 100
Список под категорий
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя категории
Возможные значения: <= 1024 characters
, Value must match regular expression ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Пиктограмма
serviceStates
object[]
Possible values: <= 50
Перечень статусов подключения услуг в подписке
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор Услуги
Возможные значения: [CHANNEL_ACTIVATION_WAIT
, SUPPLIER_VISIT_WAIT
, REGISTRATION
, TEMPORARILY_UNAVAILABLE
, AVAILABLE
, TERMINATED
]
Мнемоническое имя статуса услуги в подписке
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя статуса услуги в подписке
Возможные значения: [NONE
, CUSTOMER_DIRECTLY
, CUSTOMER_VIA_VERIFY
]
Тип ожидаемой активации услуги потребителем
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время статуса услуги в подписке
Возможные значения: >= 0
и <= 2147483647
Количество использований на площадке ПУ
bundles
object[]
Possible values: <= 50
Перечень приглашений к пакетной подписке
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Ключ права доступа на присоединение к пакетному экземпляру продукта
Возможные значения: <= 2048 characters
, Value must match regular expression ^(.*)$
Параметр права доступа на присоединение к пакетному экземпляру продукта
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Отображаемое имя в приглашении на присоединение к пакетному экземпляру продукта
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время генерации приглашения
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время изменения приглашения
Значение должно соответствовать регулярному выражению ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Идентификатор присоединившейся подписки
operations
object[]
Possible values: <= 500
Перечень операций над подпиской
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время операции