Ir al contenido
Abrir .md
En esta página

Obtener

Consulta un reembolso de factura por su ID de retiro, revisa su estado y hash en cadena y concilia su finalización.

GET/v1/refunds/:withdrawal_id

Clave de API: Payment

Devuelve el estado actual de un reembolso de factura mediante su withdrawal_id (wdr_...). Una vez que el envío alcanza completed, la respuesta incluye el tx_hash confirmado y la explorer_url.

Respuesta (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"
}

Estados del reembolso

Estado Descripción Terminal
created Reembolso creado y saldo reservado, a la espera de firma No
signed Transacción firmada y transmitida a la blockchain No
pending_review La transacción transmitida no se confirmó dentro del TTL; pendiente de revisión No
cancelling Se emitió una cancelación en cadena; esperando confirmación de qué transacción se confirma No
completed Reembolso confirmado en cadena y entregado a first_sender (is_final: true) Sí
failed El reembolso falló antes de liquidarse o se descartó; los fondos reservados volvieron al saldo del comercio Sí
cancelled El reembolso se canceló antes de transmitirse; los fondos reservados volvieron al saldo del comercio Sí

Errores

Una clave Payout (rk_) se rechaza con 403 payment_key_required. Si withdrawal_id no existe, corresponde a un retiro ordinario en lugar de un reembolso o pertenece a un proyecto fuera del alcance de tu clave, el endpoint devuelve 404 withdrawal_not_found. Consulta Códigos de error.