Перейти к содержимому
API
Открыть .md
На странице

Получить

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

GET/v1/refunds/:withdrawal_id

API-ключ: Payment

Возвращает текущее состояние возврата по его идентификатору withdrawal_id (wdr_...). Когда выплата переходит в статус completed, в ответе появляются подтверждённый tx_hash и ссылка explorer_url.

Ответ (200 OK)

{
  "withdrawal_id": "wdr_6Qm2fK8xR4vN7cT1bY9dL5",
  "invoice_id": "inv_7K2M9P4Q8R1X5Z3A0bC2dE",
  "mode": "full",
  "external_order_id": "refund-1042-full",
  "status": "completed",
  "is_final": true,
  "is_test": false,
  "amount": "100.00",
  "fee": "1.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "first_sender": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "tx_hash": "9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
  "explorer_url": "https://tronscan.org/#/transaction/9f3b8c2a1d0e4f6789abc123def4567890abc123def4567890abc123def45678",
  "created_at": 1767225600,
  "completed_at": 1767225932,
  "type": "refund",
  "project_id": "prj_3F9xL2mN8pQ4rT6vW1yZ5b"
}

Статусы возврата

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

Ошибки

Ключ Payout (rk_) отклоняется с ошибкой 403 payment_key_required. Если withdrawal_id не существует, относится к обычному выводу средств, а не к возврату, или принадлежит проекту вне области видимости вашего ключа, метод возвращает 404 withdrawal_not_found. См. Коды ошибок.