Create a Deposit
curl --request POST \
--url https://api.hel.io/v1/deposits/create/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currencyIds": [
"63430c8348c610068bcdc482"
],
"description": "<string>",
"notifyReceiverByEmail": false,
"connectWalletOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"transferManuallyOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"payWithCardOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123,
"hasWhiteListDomain": true
},
"connectExchangeOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"disabledBlockchainSymbols": [
[
"SOL",
"BASE"
]
],
"minSweepAmountUsd": 4,
"themeId": "<string>"
}
'import requests
url = "https://api.hel.io/v1/deposits/create/api-key"
payload = {
"name": "<string>",
"currencyIds": ["63430c8348c610068bcdc482"],
"description": "<string>",
"notifyReceiverByEmail": False,
"connectWalletOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"transferManuallyOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"payWithCardOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123,
"hasWhiteListDomain": True
},
"connectExchangeOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"disabledBlockchainSymbols": [["SOL", "BASE"]],
"minSweepAmountUsd": 4,
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
currencyIds: ['63430c8348c610068bcdc482'],
description: '<string>',
notifyReceiverByEmail: false,
connectWalletOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
transferManuallyOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
payWithCardOptions: {
isActive: true,
title: '<string>',
badge: '<string>',
order: 123,
hasWhiteListDomain: true
},
connectExchangeOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
disabledBlockchainSymbols: [['SOL', 'BASE']],
minSweepAmountUsd: 4,
themeId: '<string>'
})
};
fetch('https://api.hel.io/v1/deposits/create/api-key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hel.io/v1/deposits/create/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'currencyIds' => [
'63430c8348c610068bcdc482'
],
'description' => '<string>',
'notifyReceiverByEmail' => false,
'connectWalletOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'transferManuallyOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'payWithCardOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123,
'hasWhiteListDomain' => true
],
'connectExchangeOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'disabledBlockchainSymbols' => [
[
'SOL',
'BASE'
]
],
'minSweepAmountUsd' => 4,
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/deposits/create/api-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hel.io/v1/deposits/create/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposits/create/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "string",
"name": "string",
"description": "string",
"paylinkId": "string",
"platform": "HELIO",
"notifyReceiverByEmail": true,
"disabled": false,
"disabledBlockchainSymbols": [
"SOL",
"ETH"
],
"connectWalletOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 1
},
"transferManuallyOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 2
},
"payWithCardOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 3,
"hasWhiteListDomain": false
},
"connectExchangeOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 4
},
"minSweepAmountUsd": 3,
"createdAt": "2026-02-06T16:31:18.839Z",
"updatedAt": "2026-02-06T16:31:18.839Z"
}{
"message": "Api key or token is invalid",
"code": 401
}DEPOSITS
Create a Deposit
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
Create a Deposit
curl --request POST \
--url https://api.hel.io/v1/deposits/create/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"currencyIds": [
"63430c8348c610068bcdc482"
],
"description": "<string>",
"notifyReceiverByEmail": false,
"connectWalletOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"transferManuallyOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"payWithCardOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123,
"hasWhiteListDomain": true
},
"connectExchangeOptions": {
"isActive": true,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"disabledBlockchainSymbols": [
[
"SOL",
"BASE"
]
],
"minSweepAmountUsd": 4,
"themeId": "<string>"
}
'import requests
url = "https://api.hel.io/v1/deposits/create/api-key"
payload = {
"name": "<string>",
"currencyIds": ["63430c8348c610068bcdc482"],
"description": "<string>",
"notifyReceiverByEmail": False,
"connectWalletOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"transferManuallyOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"payWithCardOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123,
"hasWhiteListDomain": True
},
"connectExchangeOptions": {
"isActive": True,
"title": "<string>",
"badge": "<string>",
"order": 123
},
"disabledBlockchainSymbols": [["SOL", "BASE"]],
"minSweepAmountUsd": 4,
"themeId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
currencyIds: ['63430c8348c610068bcdc482'],
description: '<string>',
notifyReceiverByEmail: false,
connectWalletOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
transferManuallyOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
payWithCardOptions: {
isActive: true,
title: '<string>',
badge: '<string>',
order: 123,
hasWhiteListDomain: true
},
connectExchangeOptions: {isActive: true, title: '<string>', badge: '<string>', order: 123},
disabledBlockchainSymbols: [['SOL', 'BASE']],
minSweepAmountUsd: 4,
themeId: '<string>'
})
};
fetch('https://api.hel.io/v1/deposits/create/api-key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hel.io/v1/deposits/create/api-key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'currencyIds' => [
'63430c8348c610068bcdc482'
],
'description' => '<string>',
'notifyReceiverByEmail' => false,
'connectWalletOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'transferManuallyOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'payWithCardOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123,
'hasWhiteListDomain' => true
],
'connectExchangeOptions' => [
'isActive' => true,
'title' => '<string>',
'badge' => '<string>',
'order' => 123
],
'disabledBlockchainSymbols' => [
[
'SOL',
'BASE'
]
],
'minSweepAmountUsd' => 4,
'themeId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hel.io/v1/deposits/create/api-key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hel.io/v1/deposits/create/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposits/create/api-key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"currencyIds\": [\n \"63430c8348c610068bcdc482\"\n ],\n \"description\": \"<string>\",\n \"notifyReceiverByEmail\": false,\n \"connectWalletOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"transferManuallyOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"payWithCardOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123,\n \"hasWhiteListDomain\": true\n },\n \"connectExchangeOptions\": {\n \"isActive\": true,\n \"title\": \"<string>\",\n \"badge\": \"<string>\",\n \"order\": 123\n },\n \"disabledBlockchainSymbols\": [\n [\n \"SOL\",\n \"BASE\"\n ]\n ],\n \"minSweepAmountUsd\": 4,\n \"themeId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "string",
"name": "string",
"description": "string",
"paylinkId": "string",
"platform": "HELIO",
"notifyReceiverByEmail": true,
"disabled": false,
"disabledBlockchainSymbols": [
"SOL",
"ETH"
],
"connectWalletOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 1
},
"transferManuallyOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 2
},
"payWithCardOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 3,
"hasWhiteListDomain": false
},
"connectExchangeOptions": {
"isActive": true,
"title": "string",
"badge": "string",
"order": 4
},
"minSweepAmountUsd": 3,
"createdAt": "2026-02-06T16:31:18.839Z",
"updatedAt": "2026-02-06T16:31:18.839Z"
}{
"message": "Api key or token is invalid",
"code": 401
}Authorizations
Authentication using JWT token
Query Parameters
Your API key, which can be generated from the Helio Dashboard settings page.
Body
application/json
Request body for creating a deposit.
Name of the deposit.
Array containing exactly one currency ID. This value can be retrieved using the Currencies endpoint.
Required array length:
1 elementExample:
["63430c8348c610068bcdc482"]
Optional description of the deposit.
Send email notifications.
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
List of blockchain symbols for which deposits are disabled.
Available options:
SOL, ETH, POLYGON, BASE, BITCOIN, ARBITRUM, BSC, TRON, ABSTRACT, HYPERLIQUID, HYPERCORE, PLASMA Example:
[["SOL", "BASE"]]
Minimum sweep amount in USD.
Required range:
x >= 3Optional ID of a saved theme to apply to this deposit's hosted pages.
Response
Deposit created successfully.
Response body for a deposit.
Unique identifier of the deposit.
Name of the deposit.
Platform associated with the deposit.
Available options:
HELIO, MAGIC_EDEN Whether the receiver is notified by email.
Whether the deposit is disabled.
Timestamp when the deposit was created.
Timestamp when the deposit was last updated.
Description of the deposit.
Associated paylink identifier.
List of blockchain symbols for which deposits are disabled.
Available options:
SOL, ETH, POLYGON, BASE, BITCOIN, ARBITRUM, BSC, TRON, ABSTRACT, HYPERLIQUID, HYPERCORE, PLASMA Example:
[["SOL", "BASE"]]
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Configuration for a deposit payment option.
Show child attributes
Show child attributes
Minimum sweep amount in USD.
Required range:
x >= 3