xRocket Pay REST API
xRocket Pay API позволяет разработчикам интегрировать функции xRocket Pay в свои проекты, чтобы управлять чеками, переводами, счетами, запрашивать ссылки для вывода средств, выполнять снятие средств, массовые переводы, запрашивать курсы обмена и пр.
Большинство методов Pay API являются приватными и требуют авторизации с помощью Bearer token. Запросы к приватным методам без валидного токена будут отклонены.
Используйте REST API на этом веб-сайте или наш API Swagger для тестирования и просмотра примеров запросов/ответов и других деталей:
Production -Testnet
Авторизация
- Получите свой Bearer token (API Ключ) для использования приватных методов. В Telegram-боте перейдите в Настройки ➡ Настройки биржи ➡ API токен или обратитесь в службу поддержки.
- Добавьте Bearer token в запрос при использовании методов требующих авторизации следующим образом:
"Authorization: Bearer SpjEQPuvEGMae7QLaNzR8I47D3qzUP"
Ваш Bearer-токен предоставляет полный доступ к вашему аккаунту xRocket Pay — включая переводы, выводы средств и создание чеков. Никогда не публикуйте его, не сохраняйте в системах контроля версий, не встраивайте в клиентский код и не передавайте по незашифрованным каналам. Если вы подозреваете, что токен был скомпрометирован, немедленно перегенерируйте его в настройках бота.
Используйте testnet-бота для получения Bearer token для testnet-интеграции. Тестовые токены работают только с базовым URL тестнета и не затрагивают реальные балансы.
Примеры запроса/ответа
Токены, идентификаторы и суммы, показанные ниже, являются примерами для иллюстрации. Замените их на ваши реальные данные при выполнении запросов.
В этом примере метод GET /api/v1/transfer используется для запроса информации об указанной транзакции от одного пользователя xRocket к другому. Метод запрашивает данные, связанные с учетной записью xRocket. Для таких запросов требуется токен авторизации, который может быть выдан учетной записи пользователя ботом xRocket.
curl -L 'https://pay.api.pp.xrocket.tg/api/v1/transfer?transferId=123321232&clientTransferId=123456789' \
-H 'Accept: application/json'
-H 'Authorization: Bearer 10Q9DG5BG0ReG3jCdyEQ6C5yQkhHRX'
Запрос отправляется на URL API-метода: https://pay.api.pp.xrocket.tg/api/v1/transfer.
| Пример поля и значение | Описание |
|---|---|
transferId: 123321232 | ID перевода. |
clientTransferId: 123456789 | Клиентский ID перевода. |
'Authorization: Bearer 10Q9DG5BG0ReG3jCdyEQ6C5yQkhHRX' | Метод GET /api/v1/transfer запрашивает данные, связанные с учетной записью xRocket. Для таких запросов требуется токен авторизации, который может быть выдан учетной записи пользователя ботом xRocket. |
Пример ответа:
{
"transferId": "123321232",
"clientTransferId": "123456789",
"target": "87209764",
"targetType": "telegram_user_id",
"asset": "TONCOIN",
"amount": "1.23",
"description": "You are awesome!"
}
| Пример поля и значение | Описание |
|---|---|
| "transferId": "123321232" | Уникальный ID транзакции. |
| "clientTransferId": "123456789" | Уникальный ID клиентского перевода. |
| "target": "123" | Идентификатор получателя (Telegram user ID, номер телефона и пр.). |
| "targetType": "telegram_user_id" | Тип идентификатора получателя. Допустимые значения: telegram_user_id. |
| "asset": "TONCOIN" | Переводимый ассет. |
| "amount": "1.23" | Сумма перевода. |
| "description": "You are awesome!" | Описание, добавленное отправителем перевода. |
Методы
Некоторые методы Pay API выполняют необратимые финансовые операции (переводы, выводы средств, массовые переводы). Тщательно проверяйте адреса получателей, суммы и типы активов перед вызовом этих методов. Ошибочные переводы и выводы на внешние адреса не могут быть отменены.
| Метод | Описание |
|---|---|
| Чеки | Методы для обработки выплат с помощью чеков xRocket. |
| Создать чек | Создайте новый чек для перевода средств. Сумма созданного чека резервируется на балансе кошелька и может быть получена получателем или аннулирована до получения. Требуется авторизация |
| Получить список чеков | Запрос списка всех личных выпущенных чеков. Используйте этот метод для просмотра ожидающих или аннулированных чеков. Требуется авторизация |
| Удалить чек | Удалить неполученный личный чек. При отмене зарезервированные средства разблокируются на балансе кошелька. Требуется авторизация |
| Получить информацию о чеке | Получите подробную информацию об указанном личном чеке, включая статус и зарезервированную сумму. Требуется авторизация |
| Переводы | Методы для автоматических платежей пользователям непосредственно на платформе. |
| Перевести средства пользователю | Переведите средства с кошелька xRocket другому пользователю xRocket. Требуется авторизация |
| Получить список переводов | Получите список всех переводов. Требуется авторизация |
| Получить информацию о переводе | Получите информацию о переводе по его идентификатору. Требуется авторизация |
| Создать массовые переводы (только для пользователей Telegram) | Массовая пересылка активов пользователям xRocket. Требуется авторизация |
| Счета | Методы управления счетами, которые пользователи xRocket могут оплатить по ссылке. |
| Создать инвойс | Создавайте разовые счета, которые пользователи xRocket смогут оплатить по ссылке. Требуется авторизация |
| Получить список инвойсов | Получить список активных счетов. Требуется авторизация |
| Получить информацию об инвойсе | Получите информацию о счете по идентификатору. Требуется авторизация |
| Удалить инвойс | Удалить счет по идентификатору. Требуется авторизация |
| Оплатить инвойс (только для тестирования) | (Только тестовый) Метод для оплаты счета. Требуется авторизация |
| Вывод средств | Способы вывода активов с кошелька xRocket на внешние адреса. |
| Создать ссылку для вывода | Создайте ссылки для вывода средств для упрощенной интеграции. Пользователю необходимо будет подтвердить вывод после перехода по ссылке. Требуется авторизация |
| Вывести средства на внешний кошелёк | Выведите активы из кошелька xRocket на внешний адрес блокчейна. Требуется авторизация |
| Получить список выводов | Получите информацию о выводе средств из кошелька xRocket на внешний адрес блокчейна. Требуется авторизация |
| Получить информацию о выводе | Получите информацию о выводе средств с кошелька xRocket на внешний адрес блокчейна по идентификатору. Требуется авторизация |
| Получить лимиты на вывод | Получите информацию о текущих комиссиях за вывод средств. |
| Валюты и курсы | Получить информацию о валютах и их курсах. |
| Получить доступные валюты | Получите список доступных валют. |
| Получить курсы валют | Получить курсы указанной валюты в указанных валютах. |
| Приложение | Методы для получения информации о вашем приложении, проверках работоспособности API и пр. |
| Получить информацию о приложении | Получите информацию о вашем приложении. |
| Получить балансы приложения | Получите баланс вашего кошелька. Требуется авторизация |