Запрос списка услуг - /api/v20/services
Метод возвращает перечень услуг, доступных Агенту, а также их тип, входные поля, правила валидации и возможные поля для вывода пользователю.
Структура запроса
| Параметр | Значение |
|---|---|
| Метод | POST |
| URI | <url>/api/v20/services |
| URI Parameters | отсутствуют |
| Body Parameters | отсутствуют |
| Content-Type | application/json |
Структура ответа
| Параметр | Назначение | Обязателен |
|---|---|---|
services | Массив доступных услуг и их параметров | да |
serviceId | Код услуги в процессинге | да |
type | Тип схемы оплаты | да |
name | Наименование услуги | да |
group | Группа услуги | нет |
fixedPayment | Признак фиксированной суммы платежа | нет |
country | Страна предоставления услуги | нет |
inputs | Список входных параметров, которые вводит пользователь | нет |
inputs[].name | Системное имя входного параметра | нет |
inputs[].required | Признак обязательности параметра | нет |
inputs[].title | Подсказка для пользователя | нет |
inputs[].regexp | Регулярное выражение для проверки значения | нет |
displays | Список полей, которые могут быть выведены пользователю после проверки | нет |
displays[].name / required / title / regexp | Описание возвращаемого поля | нет |
Пример ответа
{
"result": 0,
"resultMessage": "OK",
"services": [
{
"serviceId": "A0001",
"type": 0,
"name": "Test Service",
"group": "Онлайн игры",
"fixedPayment": false,
"country": "Международная",
"inputs": [
{
"name": "account",
"required": true,
"title": "account"
}
]
},
{
"serviceId": "A0002",
"type": 0,
"name": "Test Service 2",
"group": "Другие услуги",
"fixedPayment": true,
"country": "КАЗАХСТАН",
"inputs": [
{
"name": "account",
"required": true,
"title": "Номер аккаунта",
"regexp": "^\\d{10}$"
},
{
"name": "ev_account1",
"required": true,
"title": "Номер заказа",
"regexp": "^\\d{10}$"
}
],
"displays": [
{
"name": "fio",
"required": true,
"title": "ФИО",
"regexp": "^.+$"
},
{
"name": "info",
"required": true,
"title": "Сумма к оплате",
"regexp": "^.+$"
},
{
"name": "fixedAmount",
"required": true,
"title": "",
"regexp": "^\\d{1,9}\\.\\d{2}$"
}
]
}
]
}