TopUp/Vouchers + Депозит
Используйте эти методы, чтобы продавать TopUp-пополнения и ваучеры клиентам, расплачиваясь депозитом мерчанта (эквайринг не требуется).
Получение списка TopUp
Получить список категорий (игр) и доступных внутриигровых пополнений
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| categories | Список | Список категорий (игр) |
| id | Строка | Номер категории |
| name | Строка | Название категории |
| fields | Список | Список обязательных параметров для создания заказа. Параметры для разных игр различаются |
| products | Список | Список позиций внутри категории (если категория недоступна, то список пустой) |
| id | Строка | Номер позиции |
| name | Строка | Название позиции |
| price | Число | Стоимость приобретения позиции в руб. |
| isAvailable | true/false | Доступность позиции |
Создание депозитного заказа TopUp
Создать заказ на покупку игровой позиции, оплачивая депозитом мерчанта
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| topupId | Да | Строка | Номер позиции |
| categoryId | Да | Строка | Номер категории |
| orderId | Да | Строка | Номер заказа |
| fields | Нет | Объект | Обязательные параметры для создания заказа. Набор зависит от выбранной категории — см. Получение списка TopUp |
| Да | Строка | Email пользователя |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа |
| topupId | Строка | Номер позиции |
| categoryId | Строка | Номер категории |
| price | Число | Стоимость приобретения позиции в руб. (списывается с депозита) |
| status | Строка | Статус заказа |
| fields | Объект | Параметры, переданные при создании заказа |
| Строка | Email пользователя |
Получение списка ваучеров
Получить список категорий (сервисов) и доступных ваучеров внутри них
→ GET /api/v1/deposit/vouchers
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| categories | Список | Список категорий (сервисов) |
| id | Строка | Номер категории |
| name | Строка | Название категории |
| products | Список | Список ваучеров внутри категории (если категория недоступна, то список пустой) |
| id | Строка | Номер ваучера |
| name | Строка | Название ваучера |
| price | Число | Стоимость приобретения ваучера в руб. |
| stock | Число | Количество доступных ваучеров |
| isAvailable | true/false | Доступность ваучера |
Создание депозитного заказа ваучеров
Создать заказ на покупку ваучеров, оплачивая депозитом мерчанта
→ POST /api/v1/deposit/vouchers
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| voucherId | Да | Строка | Номер ваучера |
| categoryId | Да | Строка | Номер категории |
| count | Да | Число | Количество приобретаемых ваучеров |
| orderId | Да | Строка | Номер заказа |
| Да | Строка | Email пользователя |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа |
| voucherId | Строка | Номер ваучера |
| categoryId | Строка | Номер категории |
| count | Число | Количество приобретенных ваучеров |
| price | Число | Стоимость приобретения ваучеров в руб. (списывается с депозита) |
| status | Строка | Статус заказа |
| codes | Список | Список кодов ваучеров (появляются после исполнения заказа) |
| Строка | Email пользователя |
Проверка статуса заказа
Проверка статуса заказа — общий метод для всех продуктов с депозитом, см. Депозитные операции