HEhel
Withdrawals

Get Withdrawal Detail

Changed on

Polls the status of a withdrawal by withdrawalDetailId. No authentication required (rate-limited).

get/v1/withdraw-details/{id}

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/withdraw-details/{id}
  • Auth
    none required

Path parameters

idstring required

The withdrawal detail ID.

Response

Withdrawal detail retrieved successfully.

withdrawalDetailIdstring
state'QUOTED' | 'SUBMITTING' | 'SUBMITTED' | 'BRIDGING' | 'COMPLETED' | 'FAILED' | 'FAILED_EXPIRED' | 'EXPIRED' | 'REFUNDED_BY_PROVIDER'
txHashstring nullable

Source-chain transaction hash of the withdrawal. For a same-chain withdrawal this is the delivery transaction. Null until the transaction is broadcast.

destinationTxHashstring nullable

Destination-chain delivery transaction hash for cross-chain withdrawals. Null until the withdrawal reaches COMPLETED, and null for same-chain withdrawals (where txHash is already the delivery transaction).

broadcastAck'acknowledged' | 'unacknowledged' | 'rejected' nullable

acknowledged = confirmed; unacknowledged = sent, keep polling; rejected = terminal failure.

errorReasonstring nullable

Human-readable error when state is FAILED.

customerIdstring nullable

Merchant-defined customer identifier set at prepare time, or null when omitted.

Changes