> ## 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.
# Get a Deposit Customer (by Token)
> Retrieves a customer linked to a specific deposit using the depositCustomerToken.
**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).
## 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.
```javascript theme={null}
const activeRoutes = response.swapRoutes.filter((route) => route.available);
```
## OpenAPI
````yaml GET /v1/deposit-customers/{depositCustomerToken}/api-key
openapi: 3.0.0
info:
title: Helio Open API
description: |-
API schema and definitions for Helio API.
The API is using two types of Authentication, for dashboard endpoints we use JSON Web Token (JWT) that is generated by self custodial wallet signing a message from API.
We also support authentication with API Key and Secret which can be generated on Helio dashboard.
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
Authentication: None
externalDocs:
description: Helio product documentation
url: https://docs.hel.io/
paths:
/v1/deposit-customers/{depositCustomerToken}/api-key:
get:
tags:
- Deposits
summary: Get a Deposit Customer (by Token)
description: >-
Retrieves a customer linked to a specific deposit using the
depositCustomerToken.
operationId: DepositController_getCustomer
parameters:
- name: apiKey
required: true
in: query
description: >-
Your API key can be generated on the Helio Dashboard’s settings
page.
schema:
type: string
- name: depositCustomerToken
required: true
in: path
description: The token associated with the deposit customer to retrieve.
schema:
type: string
responses:
'200':
description: The deposit customer was retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DepositCustomerResponse'
examples:
exportedPaymentsList:
summary: >-
Example of a successful get deposit customer by token
response
value:
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
'401':
description: Provided API key has no access to the resource.
content:
application/json:
examples:
unauthorized:
summary: Invalid or missing API key
value:
message: Api key or token is invalid
code: 401
security:
- bearer: []
components:
schemas:
DepositCustomerResponse:
type: object
properties:
id:
type: string
description: Unique identifier of the deposit customer.
deposit:
type: object
description: >-
The enriched deposit object with currencies, company, and creator
details.
depositWallets:
type: array
description: >-
Deposit wallet addresses provisioned for this customer across
supported blockchains.
items:
type: object
properties:
id:
type: string
publicKey:
type: string
description: The wallet address for this blockchain.
blockchainEngine:
type: object
properties:
id:
type: string
type:
type: string
description: Blockchain engine type (e.g. SOL, EVM, BTC).
customerId:
type: string
description: The merchant-provided customer identifier.
customerEmail:
type: string
description: Email address of the customer, if provided.
token:
type: string
description: Unique token identifying this deposit customer session.
type:
type: string
description: Type of deposit customer (e.g. DEPOSIT).
recipientPublicKeys:
type: array
description: List of recipient public keys.
items:
type: string
defaultOnrampAmount:
type: number
nullable: true
description: Default on-ramp amount, if configured.
requiredAmountMinimalUnit:
type: string
nullable: true
description: Required deposit amount in minimal token units.
requiredAmountDecimals:
type: number
nullable: true
description: Number of decimals for the required amount.
pricingCurrencyId:
type: string
nullable: true
description: ID of the pricing currency, if set.
remainingDueMinimalUnit:
type: string
nullable: true
description: Remaining amount due in minimal token units.
depositedCurrency:
type: object
nullable: true
description: >-
Currency the customer has deposited in, populated after a deposit is
detected.
properties:
symbol:
type: string
decimals:
type: number
blockchain:
type: object
properties:
symbol:
type: string
disabled:
type: boolean
description: Whether this deposit customer is disabled.
swapRoutes:
type: array
description: >-
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.
items:
$ref: '#/components/schemas/DepositCustomerSwapRoute'
DepositCustomerSwapRoute:
type: object
required:
- id
- available
- minAmountUsd
- toCurrencyId
properties:
id:
type: string
description: Identifier of the swap route.
fromCurrency:
type: object
description: Source currency for the swap route, including blockchain metadata.
properties:
id:
type: string
symbol:
type: string
name:
type: string
mintAddress:
type: string
coinMarketCapId:
type: number
decimals:
type: number
symbolPrefix:
type: string
type:
type: string
blockchain:
type: object
properties:
id:
type: string
name:
type: string
displayName:
type: string
toCurrencyId:
type: string
description: ID of the deposit payout currency.
available:
type: boolean
description: >-
Whether this swap route is currently usable. Filter out routes where
`available` is `false` to only show currencies with an active swap
path.
minAmountUsd:
type: number
description: Minimum deposit amount in USD for this route.
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Authentication using JWT token
````