Create a Customer for a Deposit
curl --request POST \
--url https://api.hel.io/v1/deposit-customers/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "<string>",
"depositId": "<string>",
"recipientPublicKeys": [
"<string>"
],
"defaultOnrampAmount": 123,
"customerEmail": "<string>",
"additionalJSON": "<string>",
"blockchainEngineTypes": []
}
'import requests
url = "https://api.hel.io/v1/deposit-customers/api-key"
payload = {
"customerId": "<string>",
"depositId": "<string>",
"recipientPublicKeys": ["<string>"],
"defaultOnrampAmount": 123,
"customerEmail": "<string>",
"additionalJSON": "<string>",
"blockchainEngineTypes": []
}
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({
customerId: '<string>',
depositId: '<string>',
recipientPublicKeys: ['<string>'],
defaultOnrampAmount: 123,
customerEmail: '<string>',
additionalJSON: '<string>',
blockchainEngineTypes: []
})
};
fetch('https://api.hel.io/v1/deposit-customers/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/deposit-customers/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([
'customerId' => '<string>',
'depositId' => '<string>',
'recipientPublicKeys' => [
'<string>'
],
'defaultOnrampAmount' => 123,
'customerEmail' => '<string>',
'additionalJSON' => '<string>',
'blockchainEngineTypes' => [
]
]),
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/deposit-customers/api-key"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\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/deposit-customers/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposit-customers/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 \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "68f8c78f600865f76e7cc866",
"deposit": "68f25d8ebe91855f9fad444b",
"token": "ba065c1b-9134-4a68-9bfc-104e5c1c7631",
"customerId": "customerId",
"recipientPublicKeys": [
"7YancRyN3yp9s6G7YNwx9H93UqswoKFqF9GuNJPufyvW"
],
"defaultOnrampAmount": 30,
"disabled": false,
"depositWallets": [
{
"id": "6985e16c78f93907a64eb29d",
"publicKey": "0x13d89374C9C2F8EdB747EE2f1D1675b05dB061eD",
"blockchainEngine": {
"id": "63b6b1200cfb4b3f6131f2b2",
"type": "EVM"
},
"createdAt": "2026-02-06T12:41:16.191Z",
"updatedAt": "2026-02-10T13:03:09.672Z"
},
{
"id": "6987a95cd68cfcabec137e41",
"publicKey": "bc1qm8xf2he4eze2g940hpnjwsamk2889mnn20mqz6",
"blockchainEngine": {
"id": "63da34127a40a721a6e0a21d",
"type": "BTC"
},
"createdAt": "2026-02-07T21:06:36.965Z",
"updatedAt": "2026-02-10T13:03:09.635Z"
},
{
"id": "6987afc15f2ed144a41ac8a3",
"publicKey": "HJiZM17UozKV6JwrysPkZ2TMxLvpeamqJKCxKEzRqXD6",
"blockchainEngine": {
"id": "63b6b1200cfb4b3f6131f2b4",
"type": "SOL"
},
"createdAt": "2026-02-07T21:33:53.427Z",
"updatedAt": "2026-02-10T13:03:09.599Z"
},
{
"id": "6987ead22a792df6401ab268",
"publicKey": "TAHgWAwvoY66pmpevaNzAEq1gh7feTKqVT",
"blockchainEngine": {
"id": "69807675403cca2d3e5582e1",
"type": "TRON"
},
"createdAt": "2026-02-08T01:45:54.761Z",
"updatedAt": "2026-02-10T13:03:09.709Z"
}
]
}{
"message": "Api key or token is invalid",
"code": 401
}Customers
Create a Customer for a Deposit
Creates a new customer linked to a specific deposit using the depositId
POST
/
v1
/
deposit-customers
/
api-key
Create a Customer for a Deposit
curl --request POST \
--url https://api.hel.io/v1/deposit-customers/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "<string>",
"depositId": "<string>",
"recipientPublicKeys": [
"<string>"
],
"defaultOnrampAmount": 123,
"customerEmail": "<string>",
"additionalJSON": "<string>",
"blockchainEngineTypes": []
}
'import requests
url = "https://api.hel.io/v1/deposit-customers/api-key"
payload = {
"customerId": "<string>",
"depositId": "<string>",
"recipientPublicKeys": ["<string>"],
"defaultOnrampAmount": 123,
"customerEmail": "<string>",
"additionalJSON": "<string>",
"blockchainEngineTypes": []
}
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({
customerId: '<string>',
depositId: '<string>',
recipientPublicKeys: ['<string>'],
defaultOnrampAmount: 123,
customerEmail: '<string>',
additionalJSON: '<string>',
blockchainEngineTypes: []
})
};
fetch('https://api.hel.io/v1/deposit-customers/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/deposit-customers/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([
'customerId' => '<string>',
'depositId' => '<string>',
'recipientPublicKeys' => [
'<string>'
],
'defaultOnrampAmount' => 123,
'customerEmail' => '<string>',
'additionalJSON' => '<string>',
'blockchainEngineTypes' => [
]
]),
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/deposit-customers/api-key"
payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\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/deposit-customers/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposit-customers/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 \"customerId\": \"<string>\",\n \"depositId\": \"<string>\",\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"defaultOnrampAmount\": 123,\n \"customerEmail\": \"<string>\",\n \"additionalJSON\": \"<string>\",\n \"blockchainEngineTypes\": []\n}"
response = http.request(request)
puts response.read_body{
"id": "68f8c78f600865f76e7cc866",
"deposit": "68f25d8ebe91855f9fad444b",
"token": "ba065c1b-9134-4a68-9bfc-104e5c1c7631",
"customerId": "customerId",
"recipientPublicKeys": [
"7YancRyN3yp9s6G7YNwx9H93UqswoKFqF9GuNJPufyvW"
],
"defaultOnrampAmount": 30,
"disabled": false,
"depositWallets": [
{
"id": "6985e16c78f93907a64eb29d",
"publicKey": "0x13d89374C9C2F8EdB747EE2f1D1675b05dB061eD",
"blockchainEngine": {
"id": "63b6b1200cfb4b3f6131f2b2",
"type": "EVM"
},
"createdAt": "2026-02-06T12:41:16.191Z",
"updatedAt": "2026-02-10T13:03:09.672Z"
},
{
"id": "6987a95cd68cfcabec137e41",
"publicKey": "bc1qm8xf2he4eze2g940hpnjwsamk2889mnn20mqz6",
"blockchainEngine": {
"id": "63da34127a40a721a6e0a21d",
"type": "BTC"
},
"createdAt": "2026-02-07T21:06:36.965Z",
"updatedAt": "2026-02-10T13:03:09.635Z"
},
{
"id": "6987afc15f2ed144a41ac8a3",
"publicKey": "HJiZM17UozKV6JwrysPkZ2TMxLvpeamqJKCxKEzRqXD6",
"blockchainEngine": {
"id": "63b6b1200cfb4b3f6131f2b4",
"type": "SOL"
},
"createdAt": "2026-02-07T21:33:53.427Z",
"updatedAt": "2026-02-10T13:03:09.599Z"
},
{
"id": "6987ead22a792df6401ab268",
"publicKey": "TAHgWAwvoY66pmpevaNzAEq1gh7feTKqVT",
"blockchainEngine": {
"id": "69807675403cca2d3e5582e1",
"type": "TRON"
},
"createdAt": "2026-02-08T01:45:54.761Z",
"updatedAt": "2026-02-10T13:03:09.709Z"
}
]
}{
"message": "Api key or token is invalid",
"code": 401
}Query Parameters
Body
application/json
Optional list of blockchain engines to provision deposit wallets for. When omitted, wallets are created for all supported engines (SOL, BTC, EVM, TRON, HYPERCORE, DOGE). Use this to limit which deposit addresses are generated — for example, pass ["EVM", "BTC"] to skip SOL if you handle Solana deposits yourself.
Available options:
SOL, BTC, EVM, TRON, HYPERCORE, DOGE Response
The deposit customer was created successfully
Optional list of blockchain engines to provision deposit wallets for. When omitted, wallets are created for all supported engines (SOL, BTC, EVM, TRON, HYPERCORE, DOGE). Use this to limit which deposit addresses are generated — for example, pass ["EVM", "BTC"] to skip SOL if you handle Solana deposits yourself.
Available options:
SOL, BTC, EVM, TRON, HYPERCORE, DOGE 