API

REST API с JSON-ответами. Один набор методов для приёма, выплат и сетлмента. Полный справочник с полями и примерами: docs.phantomflow.org.

Базовый адрес и ключи

https://api.phantomflow.org/v1

Authorization: Bearer pf_live_••••    # боевой ключ
Authorization: Bearer pf_test_••••    # песочница

Ключи создаются в кабинете. Ключ показывается один раз, храните его на сервере и не передавайте в браузер.

Основные методы

МетодПутьОписание
POST/paymentsСоздать платёж
GET/paymentsСписок платежей
GET/payments/{id}Статус и реквизиты платежа
POST/payments/{id}/cancelОтменить неоплаченный платёж
POST/payoutsСоздать выплату
GET/payouts/{id}Статус выплаты
GET/balanceБаланс по валютам
POST/settlementsВывод в USDT на подтверждённый кошелёк
GET/methodsМетоды, доступные для суммы и валюты
GET/banksСправочник банков

Статусы платежа

pending → processing → succeeded, либо failed, expired, canceled. Финальный статус приходит вебхуком, его также можно запросить через API.

Идемпотентность

Передавайте заголовок Idempotency-Key с уникальным значением. Повторный запрос с тем же ключом в течение 24 часов вернёт исходный результат и не создаст дубль. Для /settlements заголовок обязателен.

Лимиты и ошибки

В теле ошибки есть объект error с полями type, code, message и, если ошибка в параметре, param.

КодЗначение
400Неверные параметры
401Ключ не передан или недействителен
402Недостаточно средств
403У ключа нет нужного права
409Конфликт идемпотентности или состояния
422Платёж нельзя провести, например нет доступного маршрута
429Превышен лимит: 100 запросов в секунду на аккаунт
504Результат неизвестен, повторите запрос с тем же Idempotency-Key