Skip to main content
Создать выплату на внешний адрес. Списывает баланс на amount; получателю приходит amount минус сетевая комиссия (если она переложена на получателя — см. fee-config). URL: https://api.oblodai.com/v1/payout · Аутентификация: обязательна · Идемпотентность: заголовок Idempotency-Key и/или order_id (для выплат order_id обязателен).
Примеры используют хелпер call() и переменные $SECRET/$PUBLIC_ID — их определение см. в Как подписать запрос. Проще не писать подпись руками, а взять SDK.
Выплаты по API‑ключу авто‑одобряются и уходят сразу — без белых списков и периодов выдержки. Ответственность за адрес назначения на вашей стороне.

Заголовки

Любое уникальное значение (≤255 символов), одинаковое во всех повторах одной выплаты. Повтор вернёт тот же ответ и заголовок Idempotent-Replayed: true. Работает вместе с order_id. → Идемпотентность

Параметры запроса

string
обязательно
Сумма выплаты в currency.
string
обязательно
Код валюты (например USDT).
string
обязательно
Ваш номер выплаты; ключ идемпотентности.
string
обязательно
Адрес получателя.
string
Сеть (tron, ethereum, …). Обязательна для монет с несколькими сетями.
bool
Кто платит сетевую комиссию. true — комиссия сверх суммы: с баланса списывается amount + fee, получатель получает ровно amount. false — комиссия из суммы: списывается amount, получатель получает amount − fee. Не передано — действует fee-config проекта (иначе дефолт шлюза). Семантика совпадает с предрасчётом /v1/payout/calculate.
string
Тег/мемо назначения (TON Jetton). Максимум 120 символов.
string
Свой URL вебхука для этой выплаты (SSRF‑проверка).
string
Профинансировать выплату конвертацией баланса. Поддерживается только USDTcurrency.
string
по умолчанию:"api"
Метка происхождения: api (по умолчанию) или manual.
По умолчанию сетевую комиссию выплаты несёт получатель. Кто её платит, определяется настройкой проекта fee-config (общий дефолт — комиссию несёт получатель), а не полем запроса.
is_subtract учитывается и выплатой, и предрасчётом. Переданный в /v1/payout is_subtract применяется ровно так же, как его моделирует /v1/payout/calculate, поэтому превью совпадает с реальной выплатой при одинаковом значении поля. Если поле не передавать, плательщик комиссии берётся из fee‑config проекта.

Пример запроса


Пример ответа

При from_currency в result добавляется объект convert:
Полное описание полей и статусов — Объект выплаты.

Коды ошибок


Нюансы

  • Идемпотентность по (мерчант, order_id). Повтор вернёт уже созданную выплату.
  • Выплата на адрес самого шлюза запрещена (payout.destination_internal).
  • from_currency конвертирует баланс до резервирования и идемпотентна по order_id. Поддерживается только USDTcurrency.
  • Выплаты по API‑ключу авто‑одобряются (approval_required: false) — шаг /approve не нужен.
  • Перед созданием можно оценить комиссию и итоговые суммы через POST /v1/payout/calculate.
  • Много выплат?POST /v1/payout/batch — до 5000 одним запросом.

Связанные страницы

Объект выплаты

POST /v1/payout/calculate

POST /v1/payout/batch

Много выплат сразу — до 5000 одним запросом.

POST /v1/payout/mass (легаси, до 100)

Кто платит сетевую комиссию

Первая выплата