Telegram Stars + Эквайринг
Получение стоимости stars
Проверить username в Telegram и получить стоимость приобретения и минимальную цену продажи одной звезды
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| username | Да | Строка | Username пользователя в Telegram |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| starPrice | Число | Стоимость приобретения одной звезды в руб. |
| minPrice | Число | Минимальная цена продажи одной звезды в руб. (стоимость приобретения плюс минимальная комиссия WATA) |
Создание заказа
Создать заказ на покупку звезд и получить платежную ссылку.
Доход мерчанта — это цена продажи звезд минус комиссия WATA (% от цены) и стоимость приобретения звезд.
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| username | Да | Строка | Username пользователя в Telegram |
| count | Да | Число | Количество приобретаемых звезд (должно быть от 50 до 50 тыс. штук) |
| amount | Да | Число | Сумма платежа (транзакции) в рублях, на которую будет создана платежная ссылка. Всего после точки может быть 2 цифры для копеек. Пример: 1188.00. Ограничения на значение: minPrice*count <= amount <= minPrice*count*1.5. Если сумма превышает 2 тыс.руб., требуется подтверждение заказа — см. Подтверждение заказа |
| description | Да | Строка | Описание заказа или другие детали |
| telegramId | Нет | Число | ID пользователя в Telegram |
| orderId | Да | Строка | Номер заказа. Далее, номер заказа используется для определения статуса |
| successRedirectUrl | Нет | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Нет | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа. Далее, номер заказа используется для определения статуса |
| username | Строка | Username пользователя в Telegram |
| count | Число | Количество приобретаемых звезд |
| amount | Число | Сумма платежа (транзакции) в рублях, на которую создана платежная ссылка. Всего после точки может быть 2 цифры для копеек. Пример: 1188.00 |
| price | Число | Стоимость приобретения звезд в руб. |
| commission | Число | Комиссия WATA в руб. |
| description | Строка | Описание заказа или другие детали |
| paymentLink | Строка | Адрес платежной ссылки |
| successRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |
Подтверждение заказа
Подтвердить выдачу звезд.
При необходимости подтверждения заказ помещается в статус "Review". После подтверждения заказ переводится в статус "Paid".
→ POST /api/stars/order/{id}/confirm
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| id | Да | Строка | Номер заказа |
Отмена заказа
Отменить выдачу звезд.
При необходимости подтверждения заказ помещается в статус "Review". После отмены заказ переводится в статус "Refunded" (деньги возвращаются плательщику).
→ POST /api/stars/order/{id}/reject
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| id | Да | Строка | Номер заказа |
Проверка статуса заказа
Параметры запроса
| Параметр | Обязательный | Тип | Комментарий |
|---|---|---|---|
| id | Да | Строка | Номер заказа |
Параметры ответа
| Параметр | Тип | Комментарий |
|---|---|---|
| orderId | Строка | Номер заказа |
| status | Строка | Статус заказа. Возможные значения: (1) Pending (ожидание оплаты) → (2) Review (ожидание подтверждения заказа мерчантом) → (3.1) Paid (заказ оплачен и в процессе исполнения) ИЛИ (3.2) Refunded (заказ не подтвержден, платеж возвращен) → (4.1) Success (заказ исполнен) ИЛИ (4.2) Fail (ошибка) |
| username | Строка | Username пользователя в Telegram |
| count | Число | Количество приобретенных звезд |
| amount | Число | Сумма платежа (транзакции) в рублях |
| description | Строка | Детали заказа или иное |
| creationTime | Время | Время в формате ISO 8601 (UTC datetime format) |
| successRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае успешной оплаты заказа |
| failRedirectUrl | Строка | Адрес страницы магазина, на который произойдет редирект плательщика в случае неуспешной оплаты заказа |