Get payment recipients(ru)
API: http://ip:port/services/bmms/api/agent/recipients
http://ip:port/services/bmms/api/agent/recipientsМетод: GET
GETТолько пользователи, имеющие роль ROLE_AGENT
ROLE_AGENTПример ответа:
{
"categories": [
{
"id": 100000429,
"shortName": "communal_services",
"logo": "publicutilities.png",
"ord": 3,
"names": {
"ru": "Коммунальные услуги",
"uz": "Kommunal xizmatlar",
"en": "Communal services"
}
}
],
"recipients": [
{
"id": 100162851,
"shortName": "prirodniy_gaz",
"logo": "prirodniy_gaz",
"amountRatio": 1,
"minAmount": 500,
"maxAmount": 100000000,
"ord": 14,
"categoryId": 100000429,
"type": "SIMPLE",
"titles": {
"ru": "Газ",
"en": "Gas",
"uz": "Gaz"
},
"fullNames": {
"en": "Филиал газоснабжения \"HUDUDGAZ\"",
"ru": "Филиал газоснабжения \"HUDUDGAZ\"",
"uz": "Филиал газоснабжения \"HUDUDGAZ\""
}
}
],
"fields": [
{
"id": 100162952,
"name": "SERVICE_ID",
"type": "OTHER",
"contentType": "COMBOBOX",
"controlType": "SELECT",
"requireField": "REGION",
"optional": false,
"output": true,
"visibility": "ALL",
"ord": 3,
"recipientId": 100162851,
"prefixes": [],
"values": [
{
"value": "10288,10289",
"filterBy": "6896",
"ord": 1,
"titles": {
"en": "Payment",
"uz": "To'lov",
"ru": "Оплата"
},
"descriptions": {
"uz": "To'lov",
"en": "Payment",
"ru": "Оплата"
}
},
{
"value": "10254,10255",
"filterBy": "6858",
"ord": 1,
"titles": {
"ru": "Оплата",
"uz": "To'lov",
"en": "Payment"
},
"descriptions": {
"ru": "Оплата",
"uz": "To'lov",
"en": "Payment"
}
}
],
"titles": {
"uz": "Xizmat turi",
"ru": "Услуга",
"en": "Service"
},
"descriptions": {
"ru": "Услуга",
"en": "Service",
"uz": "Xizmat turi"
}
},
{
"id": 100162954,
"name": "amount",
"type": "AMOUNT",
"contentType": "MONEY",
"controlType": "TEXT",
"validation": "500:200000000",
"optional": false,
"output": true,
"visibility": "ALL",
"ord": 5,
"recipientId": 100162851,
"prefixes": [],
"values": [],
"titles": {
"en": "Summa",
"ru": "Сумма",
"uz": "Summa"
},
"descriptions": {
"ru": "Сумма",
"en": "Summa",
"uz": "Summa"
}
},
{
"id": 100162956,
"name": "licshet",
"type": "ACCOUNT",
"contentType": "STRING",
"controlType": "TEXT",
"optional": false,
"output": true,
"visibility": "ALL",
"ord": 4,
"recipientId": 100162851,
"prefixes": [],
"values": [],
"titles": {
"en": "Account",
"uz": "Hisob raqami",
"ru": "Лицевой счёт"
},
"descriptions": {
"en": "Account",
"ru": "Лицевой счёт",
"uz": "Hisob raqami"
}
},
{
"id": 100162958,
"name": "REGION",
"type": "OTHER",
"contentType": "COMBOBOX",
"controlType": "SELECT",
"maskSymbol": "*",
"optional": false,
"output": true,
"visibility": "ALL",
"ord": 1,
"recipientId": 100162851,
"prefixes": [],
"values": [
{
"value": "7356",
"ord": 14,
"titles": {
"ru": "Самарканд Газ",
"uz": "Samarqand Gaz",
"en": "Samarkand Gas"
},
"descriptions": {
"en": "Samarkand Gas",
"ru": "Самарканд Газ",
"uz": "Samarqand Gaz"
}
},
{
"value": "6849",
"ord": 11,
"titles": {
"ru": "Ташкент г. Газ",
"en": "Tashkent c. Gas",
"uz": "Toshkent sh. Gaz"
},
"descriptions": {
"ru": "Ташкент г. Газ",
"uz": "Toshkent sh. Gaz",
"en": "Tashkent c. Gas"
}
}
],
"titles": {
"en": "Region",
"uz": "Viloyat",
"ru": "Регион"
},
"descriptions": {
"en": "Region",
"ru": "Регион",
"uz": "Viloyat"
}
}
],
"responseFields": [
{
"id": 100163425,
"name": "saldo",
"visibility": "ALL",
"ord": 15,
"recipientId": 100162851,
"labels": {
"en": "Saldo",
"ru": "Остаток",
"uz": "Qoldiq"
}
}
]
} Категории:
Поле
Описание
id
Идентификационный номер
shortName
Короткое название категории
logo
Имя файла логотипа
ord
Порядковый номер
names.ru
Название на русском языке
names.uz
Название на узбекском языке
names.en
Название на английском языке
Получатели
Поле
Описание
id
Уникальный идентификатор поля.
shortName
Короткое имя.
logo
Имя файла логотипа.
amountRatio
Коэффициент или множитель для расчёта суммы. Обычно значение 100 означает необходимость конверсии.
minAmount
Минимально допустимая сумма транзакции.
maxAmount
Максимально допустимая сумма транзакции.
ord
Порядковый номер отображения услуги внутри категории.
categoryId
Идентификатор категории (например, «Коммунальные услуги»).
type
Тип услуги (одно из следующих значений:
SIMPLE — любая сумма, введённая пользователем;
AMOUNT_DICTATOR — пользователь вводит сумму X, но оплачивает X + %;
INVOICE — вводится только номер счёта, сумма определяется Paynet).
titles.ru
Название на русском языке.
titles.en
Название на английском языке.
titles.uz
Название на узбекском языке.
fullNames.ru
Полное официальное название на русском языке.
fullNames.en
Полное официальное название на английском языке.
fullNames.uz
Полное официальное название на узбекском языке.
Поля
Поле
Описание
id
Уникальный идентификатор.
name
Имя параметра, используемое при отправке запроса.
type
Тип параметра (одно из следующих значений:
ACCOUNT — номер телефона, лицевой счёт и т. д.; значение, введённое пользователем, будет отправлено в поле account запроса проверки. См. процесс проверки
AMOUNT — сумма, введённая пользователем, будет отправлена в поле amount запроса проверки;
OTHER — другое значение).
controlType
Тип элемента управления в пользовательском интерфейсе (одно из следующих значений:
TEXT — текстовое поле ввода;
SELECT — выпадающий список;
READONLY — только для чтения).
requireField
Определяет зависимость — значения этого поля зависят от указанного поля.
Поле должно быть неактивным (недоступным для заполнения или выбора), пока не будет выбрано одно из значений в секции values другого поля с таким же именем и тем же recipientId в списке fields.
optional
Указывает, является ли поле необязательным (true) или обязательным (false).
output
Определяет, должно ли значение этого поля включаться в запрос.
visibility
Отвечает за видимость в интерфейсе (одно из следующих значений: ALL, HIDDEN).
ord
Порядковый номер, определяющий порядок отображения поля.
recipientId
Идентификатор получателя, которому принадлежит это поле.
prefixes
Необязательный список допустимых префиксов для значения поля (например, +998 для номера телефона).
values
Обычно используется для полей, где controlType = SELECT. (см. подробности ниже)
Значения полей
Поле
Описание
value
Фактическое значение (или значения) опции.
filterBy
Используется для фильтрации по значению, соответствующему выбранному value поля, указанного в requireField.
ord
Порядок отображения опции в списке.
titles.en
Название опции на английском языке.
titles.ru
Название опции на русском языке.
titles.uz
Название опции на узбекском языке.
descriptions.en
Описание опции на английском языке.
descriptions.ru
Описание опции на русском языке.
descriptions.uz
Описание опции на узбекском языке.
Поля ответа
Поле
Описание
id
Уникальный идентификатор поля ответа.
name
Техническое имя поля.
visibility
Видимость в интерфейсе (ALL — отображается, HIDDEN — скрыто).
ord
Порядковый номер, определяющий порядок отображения или обработки.
recipientId
Идентификатор получателя, к которому относится данное поле.
labels.en
Название поля на английском.
labels.ru
Название поля на русском.
labels.uz
Название поля на узбекском.
Last updated