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 |