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

API

На странице

Получение

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

GET/v1/withdrawals/:withdrawal_id

API-ключ: Payout

Возвращает текущее состояние выплаты. Поля tx_hash и explorer_url появляются, когда выплата переходит в completed.

Ответ (200 OK)

{
  "withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
  "external_order_id": "payout-001",
  "status": "completed",
  "is_final": true,
  "is_test": false,
  "amount": "100.00",
  "fee": "1.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "tx_hash": "9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
  "explorer_url": "https://tronscan.org/#/transaction/9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
  "created_at": 1739289600,
  "completed_at": 1739289932
}

Статусы выплаты

Статус Описание Терминальный
created Выплата создана, ожидает подписания Нет
signed Транзакция подписана и отправлена в блокчейн Нет
cancelling Администратор инициировал отмену из pending_review; ждём подтверждения в сети, какая транзакция пройдёт Нет
completed Транзакция подтверждена в блокчейне, выплата доставлена. На проводе это финал (is_final: true), но глубокий реорг сети может вернуть выплату в signed — см. переходы ниже Да
failed Подписание не удалось до отправки в сеть, либо оператор списал зависшую выплату, либо в сети подтвердилась отмена. Средства возвращены на баланс Да
cancelled Мерчант отменил выплату в статусе created Да
pending_review Транзакция подписана, но не найдена в блокчейне после истечения TTL. Требует ручного разрешения Нет

Переходы статусов

  • created -> signed -- транзакция подписана и отправлена
  • created -> cancelled -- мерчант отменяет (единственный допустимый переход для отмены)
  • created -> failed -- ошибка подписания
  • created -> completed -- мерчант имитирует завершение через POST /v1/sandbox/withdrawals/{id}/simulate-completion (только песочница — без подписания и без блокчейна)
  • signed -> completed -- транзакция подтверждена в блокчейне
  • signed -> pending_review -- подписанная TX не найдена в блокчейне (или откатилась) после TTL; откатившаяся TX остаётся в signed, пока её не поднимет TTL
  • pending_review -> cancelling -- администратор инициирует отмену
  • pending_review -> completed -- исходная TX всё же нашлась в сети и подтвердилась (это делает сканер, а не администратор)
  • pending_review -> failed -- администратор разрешает как неудавшуюся
  • cancelling -> completed -- исходная транзакция подтвердилась первой, выплата прошла
  • cancelling -> failed -- вместо неё в сети подтвердилась транзакция отмены; средства возвращены на баланс
  • completed -> signed -- редкий случай: реорг сети вытеснил подтверждённую транзакцию выплаты, выплата возвращается в signed и завершится снова, когда эта транзакция (или её замена) попадёт в блок

Ошибки

См. Коды ошибок — полный каталог. URI в поле type каждой ошибки ведёт сразу на нужную строку.

Список выплат Отмена выплаты