HEhel
Deposits

Create a Deposit

Changed on

Creates a new deposit. A deposit can be configured with optional payment methods (card payments, wallet connect, manual transfer) and notification settings. The request must include exactly one currencyId in the currencyIds array.

post/v1/deposits/create/api-key

Request

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

Query parameters

apiKeystring required

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

Request body

namestring required

Name of the deposit.

descriptionstring

Optional description of the deposit.

currencyIdsstring[] required

Array containing exactly one currency ID. This value can be retrieved using the Currencies endpoint.

notifyReceiverByEmailboolean

Send email notifications.

disabledBlockchainSymbolsstring[]

List of blockchain symbols for which deposits are disabled.

minSweepAmountUsdnumber

Minimum sweep amount in USD.

themeIdstring

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

Example request

{
  "currencyIds": [
    "63430c8348c610068bcdc482"
  ],
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ]
}

Response

Deposit created successfully.

idstring required

Unique identifier of the deposit.

namestring required

Name of the deposit.

descriptionstring

Description of the deposit.

paylinkIdstring

Associated paylink identifier.

platform'HELIO' | 'MAGIC_EDEN' required

Platform associated with the deposit.

notifyReceiverByEmailboolean required

Whether the receiver is notified by email.

disabledboolean required

Whether the deposit is disabled.

disabledBlockchainSymbolsstring[]

List of blockchain symbols for which deposits are disabled.

minSweepAmountUsdnumber

Minimum sweep amount in USD.

createdAtstring date-time required

Timestamp when the deposit was created.

updatedAtstring date-time required

Timestamp when the deposit was last updated.

Example response

{
  "disabledBlockchainSymbols": [
    [
      "SOL",
      "BASE"
    ]
  ]
}

Changes