Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Deposits

List deposit addresses

Retrieves a list of addresses associated with your platform.

get/deposits/digital_asset_addresses

Query parameters

participant_codestring required
Example:ABCDEF

The participant whose deposit addresses should be returned. Must either match the calling platform or be a customer of the calling platform.

asset'AAVE.ETH' | 'ADA' | 'ALGO' | 'AVAX' | 'BAT.ETH' | 'BCH' | 'BTC' | 'BUSD.ETH' | 'COMP.ETH' | 'DAI.ETH' | 'DOGE' | 'DOT' | 'EGLD' | 'EOS' | 'ETC' | 'ETH' | 'ETH.ARBITRUM' | 'GRT.ETH' | 'GYEN.ETH' | 'HBAR' | 'LINK.ETH' | 'LTC' | 'LUNA' | 'MATIC.ETH' | 'MATIC.POLYGON' | 'MKR.ETH' | 'MOB' | 'SAND.ETH' | 'SOL' | 'UNI.ETH' | 'USDC.ETH' | 'USDC.ALGO' | 'USDC.POLYGON' | 'USDC.SOL' | 'USDC.HBAR' | 'USDC.XLM' | 'USDC.AVAX' | 'USDT.ETH' | 'UST' | 'WBTC.ETH' | 'XEM' | 'XLM' | 'XRP' | 'XTZ' | 'ZUSD.ETH'

The list of assets available in the certification environment

Example:USD

Filter by asset. When omitted, addresses for all assets the participant holds are returned.

inactivity_intervalnumber
Example:30

Only return addresses that have been inactive for at least this many days (1–1825).

limitnumber
Example:30

Maximum number of addresses to return (1–100). Defaults to 1.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of deposit addresses with optional filters: participant_code, asset, inactivity_interval, limit.

Example response

{
  "message": [
    {
      "created_at": 1590663417000,
      "address": "2NCgV7BXXafJZ86utcYFs5m3tCpkcpLafeG",
      "participant_code": "ABCDEF",
      "platform_code": "ABCDEF",
      "asset": "BTC",
      "account_label": "general"
    }
  ]
}