Перейти к содержимому

Документация

Документация API

Инвойсы, подписанные вебхуки, балансы и выводы через REST API Paymos. Быстрый старт, HMAC-подпись запросов, коды ошибок и тестовый режим без перевода в сеть.

Начало работы

Обзор
Изучите Merchant API Paymos: инвойсы, балансы по токенам, подписанные вебхуки и выводы в 11 сетях из 13 — по умолчанию на адреса из белого списка.
Быстрый старт
Создайте проект, проверьте инвойс и подписанный вебхук в тестовом режиме, затем выпустите рабочие ключи и примите первый реальный платёж в основной сети.
Платёжный процесс
Проследите путь инвойса от создания и выбора актива до обнаружения платежа, подтверждения, истечения срока и итогового вебхука.
Тестирование
Проверяйте состояния инвойсов и выводов с тестовыми ключами, подписанными вебхуками и методами симуляции без движения реальных средств.

API

Аутентификация
Подписывайте каждый запрос Merchant API по HMAC-SHA256: обязательные заголовки, каноническая строка, метка времени и защита от повторов.
API-ключи
Создавайте API-ключи Payment и Payout, разбирайтесь в правах и префиксах, безопасно меняйте секреты и разделяйте тестовый и рабочий доступ.
Базовый URL
Используйте единый базовый URL Merchant API для тестовых и реальных платежей: режим определяется префиксом ключа, а пути не меняются.
Поддерживаемые валюты
Проверьте, в каких из 13 блокчейн-сетей доступны USDT, USDC, USD1, DAI и обеспеченный золотом XAUT, прежде чем включать активы.
Обработка ошибок
Обрабатывайте ошибки Merchant API единообразно: формат ответа, группы HTTP-статусов, машинные коды, лимиты запросов и правила повторов.
Коды ошибок
Обрабатывайте ошибки Merchant API по стабильным машинным кодам, деталям валидации полей и документированным сценариям восстановления.

Общее

Время сервера
GET
GET /v1/time возвращает время сервера Paymos в Unix-секундах. Метод открытый: ни ключа, ни подписи. Считайте по нему смещение часов перед подписью запросов.

Инвойсы

Создание инвойса
POST
Создание платёжного инвойса для приёма криптовалютных платежей. Два потока: прямой крипто (токен указан) и фиатный (клиент выбирает токен на странице оплаты).
Список инвойсов
GET
Получайте список инвойсов со строгими фильтрами по статусу и датам и проходите результаты курсором без повторения страниц.
Подтверждение платежа
POST
Подтверждайте токен и сеть для инвойса с ценой в фиате или в токене прямо из своего интерфейса оплаты и показывайте вернувшийся адрес для зачисления.
Получение инвойса
GET
Получайте инвойс по идентификатору, проверяйте состояние оплаты и подтверждения и надёжно сверяйте ответ со своим номером заказа.
Отмена инвойса
POST
Отменяйте открытый инвойс до того, как клиент зафиксировал актив, учитывайте допустимый переход состояния и корректно обрабатывайте ответ API.
Симуляция оплаты инвойса
POST
Переводите тестовый инвойс в выбранный платёжный результат и проверяйте тот же жизненный цикл и вебхуки, что при подтверждённой транзакции.

Выводы

Создание вывода
POST
Создавайте вывод с баланса токена на кошелёк получателя, выбирайте сеть, подписывайте запрос и отслеживайте состояние.
Список выводов
GET
Получайте список выводов со строгими фильтрами и курсорной пагинацией, проверяйте сети назначения и сверяйте историю переводов.
Получение вывода
GET
Получайте вывод по идентификатору, проверяйте его состояние и ссылку на транзакцию и сверяйте завершение по подписанному вебхуку.
Отмена вывода
POST
Отменяйте ожидающий вывод до начала подписи транзакции, учитывайте допустимые состояния операции и обрабатывайте обновлённый ответ API.
Симуляция завершения вывода
POST
Завершайте ожидающий тестовый вывод без отправки транзакции и проверяйте события вебхуков по выводам от начала до конца.

Баланс

Получение балансов
GET
Получайте доступные балансы по токенам без разделения по сети входящего платежа и проверяйте сумму перед созданием вывода.

Платёжные каналы

Создание платёжного канала
POST
Создайте постоянный адрес приёма для одного плательщика по вашему собственному идентификатору — по одному адресу на каждую поддерживаемую сеть.
Список платёжных каналов
GET
Постранично читайте свои платёжные каналы от новых к старым с курсорной навигацией и фильтрами по проекту, статусу и вашему идентификатору.
Чтение платёжного канала
GET
Прочитайте один платёжный канал с постоянными адресами по сетям, списком принимаемых токенов и вашими текущими процентами комиссии.
Блокировка платёжного канала
POST
Прекратите зачислять новые депозиты на платёжный канал, не удаляя его, не освобождая адреса и не затрагивая уже полученные платежи.
Разблокировка платёжного канала
POST
Возобновите зачисление депозитов на платёжный канал: сервер сам вернёт его в active или provisioning в зависимости от наличия адреса.
Лента депозитов канала
GET
Читайте подтверждённые депозиты платёжных каналов в порядке публикации с курсором, который всегда двигается вперёд, не пропуская и не теряя платежи.
Чтение депозита канала
GET
Прочитайте один депозит платёжного канала в любом состоянии — с зафиксированными комиссиями, суммами gross fee net и подтверждениями из блокчейна.
Симуляция депозита канала
POST
Проведите депозит канала в песочнице через confirming reorged или confirmed и получите те же вебхуки, что даёт настоящий платёж в блокчейне.

Вебхуки

Вебхуки
Подключите Paymos к своему серверу через подписанные адреса вебхуков с разделением по окружениям и полным контролем доставки.
События вебхуков
Обрабатывайте все 18 событий вебхуков Paymos с явным состоянием ресурса и понятной терминальностью.
Тело события вебхука
Разбирайте версионированный webhook-envelope и полный снимок инвойса, вывода или депозита платёжного канала в поле data.
Проверка подписи
Проверяйте заголовок X-Webhook-Signature по HMAC-SHA256, безопасно сравнивайте подпись, контролируйте время и меняйте секрет без простоя.
Доставка и повторы
Учтите 11 попыток доставки вебхука примерно за 16 часов, отсекайте повторы, разбирайте ошибки и повторяйте событие после восстановления.
Тестирование вебхуков
Проверьте реальный путь тестового инвойса и доставки вебхука через интерактивную песочницу документации.

Плагины

Плагин WooCommerce
Установите официальный плагин Paymos для WooCommerce, безопасно подключите проект, проверьте оплату и обновление заказа по вебхуку.
Плагин WHMCS
Добавьте стейблкоины в счета WHMCS, включите шлюз Paymos и подключите его без ввода ключей, проверьте вебхук и сохраните существующие правила активации услуг.
Плагин OpenCart
Установите официальное расширение Paymos для OpenCart, подключите магазин без копирования секретов и проверьте статусы в тестовом режиме.
Плагин Easy Digital Downloads
Подключите Paymos к Easy Digital Downloads, проведите тестовую покупку, проверьте подписанный вебхук и выдавайте файл после подтверждения.
Плагин CS-Cart
Установите официальное дополнение Paymos для CS-Cart и Multi-Vendor, подключите проект, проверьте статусы по вебхуку и проведите тестовый заказ.
Плагин Magento 2
Установите модуль Paymos для Magento 2 или Adobe Commerce, подключите ключи двух режимов и проверьте переход заказа в оплаченный статус.
Плагин Shopware 6
Установите плагин Paymos для Shopware 6, включите его в канале продаж, проверьте подписанные статусы и смените режим без переустановки.
Плагин PrestaShop
Добавьте Paymos в PrestaShop 1.7.8+ или 8.x / 9.x, подключите магазин в один клик, проверьте подписанный вебхук и переход заказа в Payment accepted.
Paymos для Drupal Commerce
Подключите Paymos к Drupal Commerce: установка модуля, проверка платежей, Sandbox и Live, запуск cron и удаление подключения.

Интеграции

Платёжная страница
Перенаправляйте клиента на страницу оплаты или встраивайте её в защищённый iframe, а заказ исполняйте после подписанного вебхука.
Low-Code SDK для JavaScript
Добавьте на страницу настраиваемую кнопку оплаты, выберите источник суммы и оформление и откройте Paymos без собственной формы.
Терминал
Используйте ссылку проекта как терминал на телефоне или планшете: введите сумму, покажите QR-код и дождитесь подтверждения.
Серверные SDK
Используйте официальные клиенты Merchant API для JavaScript/TypeScript, Python, PHP, Go, .NET, Java, Ruby и Rust с типизированными запросами и HMAC.
MCP-сервер
Подключите Claude Code, Cursor или любой MCP-клиент к локальному серверу Paymos — агент соберёт интеграцию: инвойсы, симуляция оплаты, проверка вебхуков.