> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Withdrawal Config

> Creates a new withdrawal configuration for Solana or EVM lanes. Requires an API key with the WITHDRAWS_CREATE permission. Returns a withdrawalConfigId used for the public runtime flow.

<Info>
  **Note:** When using the production environment at [moonpay.hel.io](http://app.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](http://app.dev.hel.io).
</Info>

<Tip>
  Set `kind` to `"raw"` for standard cross-chain withdrawals or `"hyperliquid"` for Hyperliquid (HyperCore) withdrawals. Pass the source currency id in `currencyIds`. Each currency must include the `WITHDRAWAL_SOURCE` feature, use the [Get Withdrawal Currencies](/reference/currency/list-withdrawal) endpoint to find eligible ids.
</Tip>


## OpenAPI

````yaml POST /v1/withdrawal-configs/api-key
openapi: 3.0.0
info:
  title: Helio Open API
  description: |-
    API schema and definitions for Helio API. <br/> 
          The API is using two types of Authentication, for dashboard endpoints we use <b>JSON Web Token (JWT)</b> that is generated by self custodial wallet signing a message from API.</br> 
          We also support authentication with <b>API Key and Secret</b> which can be generated on <a href='https://hel.io'>Helio dashboard</a>.
  version: 1.0.0
  contact: {}
servers:
  - description: Helio API (Mainnet)
    url: https://api.hel.io
  - description: Helio API (Devnet)
    url: https://api.dev.hel.io
security: []
tags:
  - name: Webhooks
  - name: Exports
  - name: Currencies
    description: >-
      Supported currencies endpoint, includes fiat and digital assets
      </br><i>Authentication: </i><b>None</b>
externalDocs:
  description: Helio product documentation
  url: https://docs.hel.io/
paths:
  /v1/withdrawal-configs/api-key:
    post:
      tags:
        - Withdrawals
      summary: Create a Withdrawal Config
      description: >-
        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.
      operationId: WithdrawalConfigsController_createWithdrawWithApi
      parameters:
        - name: apiKey
          in: query
          required: true
          description: >-
            Your API key, which can be generated from the Helio Dashboard
            settings page.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWithdrawalConfigDto'
      responses:
        '201':
          description: Withdrawal config created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawalConfigEntity'
        '400':
          description: Validation error (e.g. currency does not support withdrawals).
        '401':
          description: Provided API key has no access to the resource.
      security:
        - bearer: []
components:
  schemas:
    CreateWithdrawalConfigDto:
      type: object
      required:
        - kind
        - name
        - currencyIds
      properties:
        kind:
          type: string
          enum:
            - raw
            - hyperliquid
          description: >-
            Withdrawal lane. Use `raw` for standard cross-chain withdrawals
            (Solana raw transactions or EVM ERC-4337 user operations). Use
            `hyperliquid` for Hyperliquid (HyperCore) withdrawals.
        name:
          type: string
          maxLength: 200
          description: Display name for the withdrawal config.
        currencyIds:
          type: array
          items:
            type: string
          minItems: 1
          description: >-
            Source currency Mongo IDs. Each must have the `WITHDRAWAL_SOURCE`
            feature.
        disabled:
          type: boolean
          description: Whether the config is disabled.
        disabledBlockchainSymbols:
          type: array
          items:
            type: string
          description: Blockchains to disable for this config.
        enabledFeatures:
          type: array
          items:
            type: string
            enum:
              - iron
          description: Optional feature flags. `iron` enables Iron.xyz auto off-ramp.
    WithdrawalConfigEntity:
      type: object
      properties:
        id:
          type: string
          description: The withdrawal config ID (`withdrawalConfigId`).
        name:
          type: string
        platform:
          type: string
        disabled:
          type: boolean
        disabledBlockchainSymbols:
          type: array
          items:
            type: string
        enabledFeatures:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authentication using JWT token

````