---
title: "Get a Deposit Customer (by Token)"
method: GET
path: "/v1/deposit-customers/{depositCustomerToken}/api-key"
tags: ["Deposits"]
---

# Get a Deposit Customer (by Token)

`GET /v1/deposit-customers/{depositCustomerToken}/api-key`

## Request

- Base URL: `https://api.hel.io`
- URL: `https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key`
- Auth: HTTP bearer

Retrieves a customer linked to a specific deposit using the depositCustomerToken.

## Path parameters

- `depositCustomerToken` string, required

## Query parameters

- `apiKey` string, required

## Response `200`

The deposit customer was retrieved successfully

- DepositCustomerResponse
  - `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.
    - `id` string
    - `publicKey` string: The wallet address for this blockchain.
    - `blockchainEngine` object
      - `id` string
      - `type` string: Blockchain engine type (e.g. SOL, EVM, BTC).
  - `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, nullable: Default on-ramp amount, if configured.
  - `requiredAmountMinimalUnit` string, nullable: Required deposit amount in minimal token units.
  - `requiredAmountDecimals` number, nullable: Number of decimals for the required amount.
  - `pricingCurrencyId` string, nullable: ID of the pricing currency, if set.
  - `remainingDueMinimalUnit` string, nullable: Remaining amount due in minimal token units.
  - `depositedCurrency` object, nullable: Currency the customer has deposited in, populated after a deposit is detected.
    - `symbol` string
    - `decimals` number
    - `blockchain` object
      - `symbol` string
  - `disabled` boolean: Whether this deposit customer is disabled.
  - `swapRoutes` DepositCustomerSwapRoute[]: 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.
    - `id` string, required: Identifier of the swap route.
    - `fromCurrency` object: Source currency for the swap route, including blockchain metadata.
      - `id` string
      - `symbol` string
      - `name` string
      - `mintAddress` string
      - `coinMarketCapId` number
      - `decimals` number
      - `symbolPrefix` string
      - `type` string
      - `blockchain` object
        - `id` string
        - `name` string
        - `displayName` string
    - `toCurrencyId` string, required: ID of the deposit payout currency.
    - `available` boolean, required: Whether this swap route is currently usable. Filter out routes where `available` is `false` to only show currencies with an active swap path.
    - `minAmountUsd` number, required: Minimum deposit amount in USD for this route.

## Other responses

- `401`: Provided API key has no access to the resource.

---

[API](https://skmtc.dev/hel/apis/helio-open-api.md) - [All operations](https://skmtc.dev/hel/apis/helio-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hel/apis/helio-open-api/revisions/5988f1c713e0?raw)