List supported crypto currencies

GET

/currencies

Returns every crypto currency the platform supports together with their network, decimal places, deposit / withdrawal minimums, the payer network fee added to each deposit, and the effective tenant-wide deposit commission. Optionally filterable by network.

Required scope: currencies.list.

Authorizations

TENANT_API_KEY

Parameters

Query Parameters

network

string

Allowed values: Tron Solana Ethereum BNB BTC Base

Optional filter: only return currencies on this network (e.g. Tron to fetch only TRC-20 assets).

Responses

200

application/json

object

data

required

Array<object>

object

code

required

Currency code.

string

Allowed values: USDT_TRC20 USDT_ERC20 USDT_BEP20 USDC_ERC20 USDC_BEP20 USDC_BASE EURC_BASE LINK_ERC20 LINK_BEP20 ETH TRX BNB BTC ETH_BASE

name

required

Human-readable currency name.

string

network

required

Blockchain network the currency lives on.

string

Allowed values: Tron Solana Ethereum BNB BTC Base

tokenType

Token standard (ERC20, TRC20, BEP20, …) for non-native assets. Omitted for chain-native coins.

string

Allowed values: erc20 trc20 bep20

decimalPlaces

required

Number of decimal places. Use to format on-chain amounts for display.

number

minDepositAmount

required

Smallest accepted deposit amount in this currency, raised to cover the network fee. Deposits below this threshold are not credited.

number

depositNetworkFee

required

Current payer network fee; null while no live quote exists, in which case new deposits in this currency are temporarily refused.

object

amount

required

Fee in the currency units; withheld from each deposit before the commission, and added on top of invoice amounts.

number

quotedAt

required

When the fee was quoted. Fees refresh every few minutes.

string format: date-time

minWithdrawalAmount

required

Smallest accepted withdrawal amount in this currency.

number

depositCommission

required

Effective deposit commission for the authenticated tenant. Reflects the per-tenant override when configured, otherwise the system default.

number

contractAddress

required

Smart contract address for token currencies (null for native coins).

string

nullable

imageUrl

required

Optional URL to a currency icon, suitable for UI display.

string

nullable

networkIconUrl

Optional URL for the underlying chain / network icon (e.g. on multi-network stablecoin pickers).

string

nullable

addressMask

required

Optional regex (as a string) merchants can run client-side to pre-validate destination addresses before calling POST /withdrawal/quote.

string

nullable

Example

{
  "data": [
    {
      "code": "USDT_TRC20",
      "network": "Tron",
      "tokenType": "erc20",
      "depositNetworkFee": {
        "amount": 1.25
      },
      "depositCommission": 0.005
    }
  ]
}

400

Invalid network filter value.

401

Missing or invalid x-tenant-api-key header. Code: exceptions.auth.invalidApiKey.

application/json

object

code

required

Stable machine-readable error code, namespaced under exceptions.. Always prefer branching on this value over message. See the per-route descriptions for the codes that route emits.

string

message

required

Human-readable explanation. Subject to wording changes; for programmatic checks use code instead.

string

extension

Optional structured payload accompanying the error. For exceptions.rateLimit.exceeded includes msBeforeNext; for validation errors includes the offending field info.

object

key

additional properties

any

Example

{
  "code": "exceptions.auth.invalidApiKey",
  "message": "Invalid or missing API key"
}

403

Request origin IP is not on the tenant API allowlist (exceptions.auth.ipNotAllowed), or the API key is missing the scope required by this operation (exceptions.auth.insufficientScope).

application/json

object

code

required

Stable machine-readable error code, namespaced under exceptions.. Always prefer branching on this value over message. See the per-route descriptions for the codes that route emits.

string

message

required

Human-readable explanation. Subject to wording changes; for programmatic checks use code instead.

string

extension

Optional structured payload accompanying the error. For exceptions.rateLimit.exceeded includes msBeforeNext; for validation errors includes the offending field info.

object

key

additional properties

any

Example

{
  "code": "exceptions.auth.invalidApiKey",
  "message": "Invalid or missing API key"
}

429

Rate limit exceeded for this endpoint. Retry after the window resets. Code: exceptions.rateLimit.exceeded. The extension.msBeforeNext field tells you how long to wait.

application/json

object

code

required

Stable machine-readable error code, namespaced under exceptions.. Always prefer branching on this value over message. See the per-route descriptions for the codes that route emits.

string

message

required

Human-readable explanation. Subject to wording changes; for programmatic checks use code instead.

string

extension

Optional structured payload accompanying the error. For exceptions.rateLimit.exceeded includes msBeforeNext; for validation errors includes the offending field info.

object

key

additional properties

any

Example

{
  "code": "exceptions.auth.invalidApiKey",
  "message": "Invalid or missing API key"
}

500

Unexpected server error. Safe to retry idempotent operations after a backoff.

application/json

object

code

required

Stable machine-readable error code, namespaced under exceptions.. Always prefer branching on this value over message. See the per-route descriptions for the codes that route emits.

string

message

required

Human-readable explanation. Subject to wording changes; for programmatic checks use code instead.

string

extension

Optional structured payload accompanying the error. For exceptions.rateLimit.exceeded includes msBeforeNext; for validation errors includes the offending field info.

object

key

additional properties

any

Example

{
  "code": "exceptions.auth.invalidApiKey",
  "message": "Invalid or missing API key"
}