amount; получателю приходит amount минус
сетевая комиссия (если она переложена на получателя — см. fee-config).
URL: https://api.oblodai.com/v1/payout · Аутентификация: обязательна · Идемпотентность: заголовок Idempotency-Key и/или order_id (для выплат order_id обязателен).
Примеры используют хелпер
call() и переменные $SECRET/$PUBLIC_ID — их определение см. в
Как подписать запрос. Проще не писать подпись руками, а взять
SDK.Заголовки
Любое уникальное значение (≤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
Профинансировать выплату конвертацией баланса. Поддерживается только
USDT → currency.string
по умолчанию:"api"
Метка происхождения:
api (по умолчанию) или manual.is_subtract учитывается и выплатой, и предрасчётом. Переданный в /v1/payout is_subtract
применяется ровно так же, как его моделирует
/v1/payout/calculate, поэтому превью совпадает с реальной
выплатой при одинаковом значении поля. Если поле не передавать, плательщик комиссии берётся из
fee‑config проекта.Пример запроса
Пример ответа
from_currency в result добавляется объект convert:
Коды ошибок
Нюансы
- Идемпотентность по
(мерчант, order_id). Повтор вернёт уже созданную выплату. - Выплата на адрес самого шлюза запрещена (
payout.destination_internal). from_currencyконвертирует баланс до резервирования и идемпотентна поorder_id. Поддерживается толькоUSDT→currency.- Выплаты по API‑ключу авто‑одобряются (
approval_required: false) — шаг/approveне нужен. - Перед созданием можно оценить комиссию и итоговые суммы через
POST /v1/payout/calculate. - Много выплат? →
POST /v1/payout/batch— до 5000 одним запросом.
Связанные страницы
Объект выплаты
POST /v1/payout/calculate
POST /v1/payout/batch
Много выплат сразу — до 5000 одним запросом.