Skip to main content
GET
/
v1
/
deposit-customers
/
{depositCustomerToken}
/
api-key
Get a Deposit Customer (by Token)
curl --request GET \
  --url https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key \
  --header 'Authorization: Bearer <token>'
{
  "id": "691df9bc2c2ba3462f7bbb90",
  "deposit": {
    "id": "691df9b7dc08fb6c7bb0c4d9",
    "description": "",
    "name": "depositacitivitytest",
    "platform": "HELIO",
    "isCardPaymentEnabled": true,
    "notifyReceiverByEmail": false,
    "createdAt": "2025-11-19T17:09:11.609Z",
    "updatedAt": "2025-11-19T17:09:11.609Z",
    "currencies": [
      {
        "id": "6340313846e4f91b8abc519b",
        "name": "USD Coin",
        "decimals": 6,
        "order": 150,
        "mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "coinMarketCapId": 3408,
        "symbol": "USDC",
        "symbolPrefix": "$",
        "type": "DIGITAL",
        "iconUrl": "USDC.svg",
        "features": [
          "PAYMENT_PRICING",
          "PAYMENT_RECIPIENT",
          "SWAP",
          "DEPOSIT_MERCHANT_RECIPIENT",
          "DEPOSIT_CUSTOMER_CHECKOUT"
        ],
        "orderingType": "NUMERIC",
        "blockchain": {
          "id": "6340313846e4f91b8abc515c",
          "name": "SOL",
          "symbol": "SOL",
          "engine": {
            "id": "63b6b1200cfb4b3f6131f2b4",
            "type": "SOL"
          }
        }
      }
    ],
    "company": {
      "id": "667c1f9352919e407156128c",
      "name": "Helio",
      "email": "jesse@hel.io",
      "websiteUrl": "",
      "discordUsername": "",
      "address": "",
      "phoneNumber": "",
      "escrowFunds": false,
      "twitterConfirmed": false,
      "kycVerified": false,
      "kybVerified": false,
      "customTheme": {
        "primaryColor": "#6400CC",
        "neutralColor": "#5A6578",
        "themeMode": "DARK",
        "textColorOnButton": "BLACK",
        "backgroundColor": "#f9f9f9"
      }
    },
    "creator": {
      "id": "667c1f9352919e407156128a",
      "userType": "MERCHANT",
      "email": "jesse.baffour@helio.co",
      "name": "",
      "isDisabled": false,
      "kycVerified": false,
      "platformDetails": {
        "platform": "HELIO"
      }
    }
  },
  "token": "e7944a16-8910-4385-ba32-daf74c9b9e7b",
  "customerId": "test324",
  "recipientPublicKeys": [
    "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW"
  ],
  "depositWallets": [
    {
      "id": "691df9bc2c2ba3462f7bbb97",
      "publicKey": "Av4bS82bJKKtnuEz6DvVRiTWVgM1gMtenEYvks42w8Kn",
      "blockchainEngine": {
        "id": "63b6b1200cfb4b3f6131f2b4",
        "type": "SOL"
      }
    },
    {
      "id": "691df9bd2c2ba3462f7bbb9a",
      "publicKey": "bc1qjxjjcwfz0fa7v38l66q5nu6nxymh0dkapgwvqe",
      "blockchainEngine": {
        "id": "63da34127a40a721a6e0a21d",
        "type": "BTC"
      }
    },
    {
      "id": "691df9bd2c2ba3462f7bbb9d",
      "publicKey": "0xB875E9Dc1C7Ab18a0b919cde4670751DD91D3F1D",
      "blockchainEngine": {
        "id": "63b6b1200cfb4b3f6131f2b2",
        "type": "EVM"
      }
    }
  ],
  "disabled": false,
  "swapRoutes": [
    {
      "id": "6750a1b2c3d4e5f6a7b8c9d0",
      "fromCurrency": {
        "id": "6340313846e4f91b8abc51a3",
        "symbol": "SOL",
        "name": "Solana",
        "mintAddress": "So11111111111111111111111111111111111111112",
        "coinMarketCapId": 5426,
        "decimals": 9,
        "symbolPrefix": "",
        "type": "DIGITAL",
        "blockchain": {
          "id": "6340313846e4f91b8abc515c",
          "name": "SOL",
          "displayName": "Solana"
        }
      },
      "toCurrencyId": "6340313846e4f91b8abc519b",
      "available": true,
      "minAmountUsd": 1.5
    },
    {
      "id": "6750a1b2c3d4e5f6a7b8c9d1",
      "fromCurrency": {
        "id": "6340313846e4f91b8abc51b2",
        "symbol": "ETH",
        "name": "Ethereum",
        "mintAddress": "0x0000000000000000000000000000000000000000",
        "coinMarketCapId": 1027,
        "decimals": 18,
        "symbolPrefix": "",
        "type": "DIGITAL",
        "blockchain": {
          "id": "6340313846e4f91b8abc515d",
          "name": "ETH",
          "displayName": "Ethereum"
        }
      },
      "toCurrencyId": "6340313846e4f91b8abc519b",
      "available": false,
      "minAmountUsd": 5
    }
  ]
}

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.

Note: When using the production environment at moonpay.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.

​
Swap routes and minimum amounts

The response includes a swapRoutes array containing the available swap paths into the deposit’s payout currency. Each route object provides:
  • available — true when the swap path is currently usable. Filter out routes where available is false so your UI only surfaces currencies with an active swap path.
  • minAmountUsd — the minimum deposit amount in USD for this route. Use this value to enforce or display minimum deposit thresholds per currency in your checkout flow.
  • fromCurrency — the source currency and its blockchain metadata.
  • toCurrencyId — the ID of the deposit’s configured payout currency.
const activeRoutes = response.swapRoutes.filter((route) => route.available);

Authorizations

​
Authorization
string
header
required

Authentication using JWT token

Path Parameters

​
depositCustomerToken
string
required

The token associated with the deposit customer to retrieve.

Query Parameters

​
apiKey
string
required

Your API key can be generated on the Helio Dashboard’s settings page.

Response

The deposit customer was retrieved successfully

​
id
string

Unique identifier of the deposit customer.

​
deposit
object

The enriched deposit object with currencies, company, and creator details.

​
depositWallets
object[]

Deposit wallet addresses provisioned for this customer across supported blockchains.

​
customerId
string

The merchant-provided customer identifier.

​
customerEmail
string

Email address of the customer, if provided.

​
token
string

Unique token identifying this deposit customer session.

​
type
string

Type of deposit customer (e.g. DEPOSIT).

​
recipientPublicKeys
string[]

List of recipient public keys.

​
defaultOnrampAmount
number | null

Default on-ramp amount, if configured.

​
requiredAmountMinimalUnit
string | null

Required deposit amount in minimal token units.

​
requiredAmountDecimals
number | null

Number of decimals for the required amount.

​
pricingCurrencyId
string | null

ID of the pricing currency, if set.

​
remainingDueMinimalUnit
string | null

Remaining amount due in minimal token units.

​
depositedCurrency
object

Currency the customer has deposited in, populated after a deposit is detected.

​
disabled
boolean

Whether this deposit customer is disabled.

​
swapRoutes
object[]

Available swap routes into the deposit's payout currency. Each entry includes available to indicate whether the route is usable and minAmountUsd for the minimum deposit amount in USD.