Skip to main content
GET
Get Withdrawal Detail
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1. For the development environment, use api.dev.hel.io/v1.
Poll every ~3 seconds until the withdrawal reaches a terminal state (COMPLETED, FAILED, FAILED_EXPIRED, EXPIRED, or REFUNDED_BY_PROVIDER). When set at prepare time, customerId is echoed on this response.

Path Parameters

id
string
required

The withdrawal detail ID.

Response

Withdrawal detail retrieved successfully.

withdrawalDetailId
string
state
enum<string>
Available options:
QUOTED,
SUBMITTING,
SUBMITTED,
BRIDGING,
COMPLETED,
FAILED,
FAILED_EXPIRED,
EXPIRED,
REFUNDED_BY_PROVIDER
txHash
string | null

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

destinationTxHash
string | null

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
enum<string> | null

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

Available options:
acknowledged,
unacknowledged,
rejected
errorReason
string | null

Human-readable error when state is FAILED.

customerId
string | null

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