Skip to main content
GET
Get a Withdrawal Transaction by Signature
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.
The hash path parameter matches any entry in the withdrawal’s transaction history, not only the most recent txHash.

Authorizations

Authorization
string
header
required

Authentication using JWT token

Path Parameters

hash
string
required

Blockchain transaction hash or signature.

Query Parameters

apiKey
string
required

Your API key, which can be generated from the Helio Dashboard settings page.

Response

Withdrawal transaction retrieved successfully.

withdrawalDetailId
string

Withdrawal detail ID.

state
enum<string>
Available options:
QUOTED,
SUBMITTING,
SUBMITTED,
BRIDGING,
COMPLETED,
FAILED,
FAILED_EXPIRED,
EXPIRED,
REFUNDED_BY_PROVIDER
sourceChain
string

Source chain symbol.

sourceToken
string

Source token symbol.

sourceAmount
string

Source amount in atomic units.

destinationChain
string

Destination chain symbol.

destinationToken
string

Destination token symbol.

destinationAmount
string

Destination amount in atomic units.

destinationWallet
string

Destination wallet address.

txHash
string | null

Most recent transaction hash associated with the withdrawal.

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 the withdrawal failed.

customerId
string | null

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

createdAt
string<date-time>
updatedAt
string<date-time>