> ## 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 Swap Route Statuses (Deposit Customer)
> Returns per–from-currency swap route availability for the deposit linked to a deposit customer token. Use `available` to hide currencies without a working swap path.
**Deprecated:** This endpoint is deprecated. Use the [Get Deposit Customer](/reference/deposit-customers/retrieve) endpoint instead, which returns `swapRoutes` directly in the response with `available` and `minAmountUsd` per route.
**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).
## Filtering by availability
The response `data` array includes every tracked route; each object has an `available` boolean. To show only currencies that currently have a usable swap path into the deposit’s payout asset, **omit entries where `available` is `false`** (for example in JavaScript: `data.filter((item) => item.available)`).
`available` reflects the latest route checks on the server; the endpoint may be cached for a short window (\~30 seconds).
## OpenAPI
````yaml GET /v1/swap-route-statuses/to-deposit-customer/{token}
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/swap-route-statuses/to-deposit-customer/{token}:
get:
tags:
- Deposits
summary: Get swap route statuses for a deposit customer
description: >-
Returns swap route availability for each **from** currency that can be
used to fund the deposit associated with the given **deposit customer
token**. The API resolves the token to the deposit’s configured payout
currency (`deposit.currencies[0]`) and returns the same swap-route data
as the internal `to-currency` lookup for that currency.
Each item includes `available`. Treat `available: false` as routes you
should not offer for swaps; filter those out if you only want currently
routable pairs.
**Authentication:** none (public). Responses may be cached briefly
(about 30 seconds).
operationId: SwapRouteStatusController_getByDepositCustomerToken
parameters:
- name: token
in: path
required: true
description: >-
The deposit customer token (same identifier used elsewhere for
deposit customer APIs).
schema:
type: string
responses:
'200':
description: Swap route statuses for routes into the deposit’s payout currency.
content:
application/json:
schema:
$ref: '#/components/schemas/SwapRouteStatusResponse'
examples:
swapRoutes:
summary: Routes with mixed availability
value:
data:
- id: 67acdb5ee316ca7a58b7e7dc
fromCurrency:
id: 6340313846e4f91b8abc519b
symbol: USDC
name: USD Coin
decimals: 6
blockchain:
id: 6340313846e4f91b8abc515c
name: SOL
symbol: SOL
toCurrency:
id: 63430c8348c610068bcdc482
symbol: USDC
name: USD Coin
decimals: 6
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
available: true
- id: 67acdb5ee316ca7a58b7e7dd
fromCurrency:
id: '623423423423423423423423'
symbol: ETH
name: Ethereum
decimals: 18
blockchain:
id: 63b6b1200cfb4b3f6131f2b2
name: ETH
symbol: ETH
toCurrency:
id: 63430c8348c610068bcdc482
symbol: USDC
name: USD Coin
decimals: 6
blockchain:
id: 63430c8348c610068bcdc43c
name: SOL
symbol: SOL
available: false
'404':
description: >-
The deposit customer token is unknown, the deposit has no currencies
configured, or related data could not be found.
content:
application/json:
schema:
type: object
properties:
message:
type: string
statusCode:
type: number
components:
schemas:
SwapRouteStatusResponse:
type: object
required:
- data
properties:
data:
type: array
description: Swap routes into the deposit’s configured payout currency.
items:
$ref: '#/components/schemas/SwapRouteStatusItem'
SwapRouteStatusItem:
type: object
required:
- id
- available
properties:
id:
type: string
description: Identifier of the swap route status record.
fromCurrency:
nullable: true
description: >-
Source currency for the swap route, including blockchain metadata
when present.
allOf:
- $ref: '#/components/schemas/Currency'
toCurrency:
nullable: true
description: >-
Destination (deposit payout) currency for the route, including
blockchain metadata when present.
allOf:
- $ref: '#/components/schemas/Currency'
available:
type: boolean
description: >-
When `false`, the route should not be offered for swaps; filter
these items out if you only display currencies with an active swap
path.
Currency:
type: object
properties:
blockchain:
$ref: '#/components/schemas/Blockchain'
id:
type: string
symbol:
type: string
name:
type: string
mintAddress:
type: string
coinMarketCapId:
type: number
decimals:
type: number
minDecimals:
type: number
symbolPrefix:
type: string
order:
type: number
type:
enum:
- FIAT
- DIGITAL
type: string
features:
type: array
items:
type: string
enum:
- PAYMENT_PRICING
- PAYMENT_RECIPIENT
- SWAP
iconUrl:
type: string
required:
- blockchain
- id
- symbol
- name
- mintAddress
- coinMarketCapId
- decimals
- order
Blockchain:
type: object
properties:
engine:
$ref: '#/components/schemas/BlockchainEngine'
id:
type: string
name:
type: string
symbol:
type: string
enum:
- SOL
- ETH
- POLYGON
- BASE
- BITCOIN
required:
- engine
- id
- name
- symbol
BlockchainEngine:
type: object
properties:
id:
type: string
type:
type: string
enum:
- EVM
- SOL
- BTC
required:
- id
- type
````