Withdrawals

Create a Withdrawal Config

Creates a new withdrawal configuration. Requires an API key with the WITHDRAWS_CREATE permission. Set kind to raw for standard cross-chain withdrawals or hyperliquid for Hyperliquid (HyperCore) withdrawals, and pass the source currency id(s) in currencyIds. Returns a withdrawalConfigId used for the public runtime flow.

post/v1/withdrawal-configs/api-key

Query parameters

apiKeystring required

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

Request body

kind'raw' | 'hyperliquid' required

Withdrawal lane. Use raw for standard cross-chain withdrawals (Solana raw transactions or EVM ERC-4337 user operations). Use hyperliquid for Hyperliquid (HyperCore) withdrawals.

namestring required

Display name for the withdrawal config.

currencyIdsstring[] required

Source currency Mongo IDs. Each must have the WITHDRAWAL_SOURCE feature.

disabledboolean

Whether the config is disabled.

disabledBlockchainSymbolsstring[]

Blockchains to disable for this config.

enabledFeaturesstring[]

Optional feature flags. iron enables Iron.xyz auto off-ramp.

Response

Withdrawal config created successfully.

idstring

The withdrawal config ID (withdrawalConfigId).

namestring

platformstring

disabledboolean

disabledBlockchainSymbolsstring[]

enabledFeaturesstring[]

createdAtstring date-time

updatedAtstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.