Skip to main content
GET
List Withdrawal Transactions
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.
Use page and limit for offset pagination, or lastItemId for cursor pagination. Default page size is 20 (max 100). Amounts are returned in atomic units.

Authorizations

Authorization
string
header
required

Authentication using JWT token

Query Parameters

apiKey
string
required

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

page
number

Page number (1-based).

limit
number
default:20

Page size. Defaults to 20, maximum 100.

Required range: x <= 100
lastItemId
string

Cursor for pagination. Returns items with _id less than this value.

Search by withdrawal detail ID, destination wallet (prefix), source token, or destination token.

sort
string
default:createdAt

Sort field. Defaults to createdAt.

order
enum<string>
default:desc

Sort order. Defaults to desc.

Available options:
asc,
desc
startDate
string

ISO 8601 start of createdAt range (inclusive).

endDate
string

ISO 8601 end of createdAt range (inclusive).

state
enum<string>[]

Filter by one or more withdrawal states.

Available options:
QUOTED,
SUBMITTING,
SUBMITTED,
BRIDGING,
COMPLETED,
FAILED,
FAILED_EXPIRED,
EXPIRED,
REFUNDED_BY_PROVIDER
sourceChain
string

Filter by source chain symbol (e.g. SOL, ETH).

destinationChain
string

Filter by destination chain symbol.

withdrawalConfigId
string

Filter by withdrawal config ID.

Response

Withdrawal transactions 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>