Vouchers + Эквайринг
Получение списка сервисов и ваучеров
Получить список сервисов и ваучеров внутри сервисов
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| categoryId | Число | Номер сервиса |
| categoryName | Строка | Название сервиса |
| type | Строка | Категория ЦТ ("VoucherCode") |
| fields | Список | Список обязательных параметров для создания заказа |
| vouchers | Список | Список ваучеров внутри сервиса |
| id | Число | Номер ваучера |
| name | Строка | Название ваучера |
| price | Число | Стоимость приобретения ваучера в руб. |
| minPrice | Число | Минимальная цена продажи в руб. (стоимость приобретения плюс минимальная комиссия WATA) |
| isAvailable | true/false | Доступность ваучера |
| stock | Число | Количество доступных ваучеров |
Покупка ваучеров
Создать заказ на покупку ваучеров и получить платежную ссылку.
Доход мерчанта — это цена продажи ваучеров минус комиссия WATA (% от цены) и стоимость приобретения ваучеров
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| voucherId | Да | Число | Номер ваучера. Для получения номеров ваучеров необходимо использовать метод «Получение списка сервисов и ваучеров» |
| amount | Да | Число | Цена продажи ваучеров в рублях (на данную сумму создается платежная ссылка). Ограничения на значение: minPrice*count <= amount <= minPrice*count*1.5 |
| count | Да | Число | Количество приобретаемых ваучеров |
| orderId | Да | Строка | Номер заказа |
| Да | Строка | Email пользователя | |
| description | Да | Строка | Комментарии к заказу |
| successRedirectUrl | Нет | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Нет | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа |
| amount | Число | Цена продажи ваучеров в руб. |
| commission | Число | Комиссия WATA в руб. |
| orderPrice | Число | Стоимость приобретения ваучеров в руб. |
| voucherId | Число | Номер ваучера |
| count | Число | Количество приобретенных ваучеров |
| Строка | Email пользователя | |
| paymentLink | Строка | Адрес платежной ссылки |
| successRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |
Получение кодов ваучеров
Получить статус заказа и коды ваучеров по номеру заказа.
Появление кодов ваучеров в ответе может занимать до 10 минут после оплаты заказа
→ GET /api/v3/vouchers/order/{id}
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| id | Да | Строка | Номер заказа |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа |
| status | Строка | Статус заказа. Возможные значения: Pending (ожидание оплаты) → Paid (заказ оплачен, в процессе исполнения) → Success (заказ исполнен) / Fail (ошибка) |
| vouchers | Список | Список кодов ваучеров |
| amount | Число | Цена продажи ваучеров в руб. |
| orderPrice | Число | Стоимость приобретения ваучеров в руб. |
| voucherId | Число | Номер ваучера |
| count | Число | Количество приобретенных ваучеров |
| Строка | Email пользователя | |
| paymentLink | Строка | Платежная ссылка |
| successRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |