HEhel
Withdrawals

Create a Withdrawal Config

Changed on

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

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/withdrawal-configs/api-key
  • Auth
    HTTP bearer

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.

themeIdstring

Optional ID of a saved theme to apply to this withdrawal config's hosted pages.

Response

Withdrawal config created successfully.

idstring

The withdrawal config ID (withdrawalConfigId).

namestring
platformstring
disabledboolean
disabledBlockchainSymbolsstring[]
enabledFeaturesstring[]
createdAtstring date-time
updatedAtstring date-time

Changes