Deposits

Create deposit address

Changed on

Creates a deposit address for a given asset.

post/deposits/digital_asset_addresses

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/deposits/digital_asset_addresses
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

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.

Request body

participant_codestring required

The participant to create the address for. Must either match the calling platform or be a customer of the calling platform.

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

The asset symbol to create a deposit address for (e.g. BTC, USDC.ETH).

account_labelstring

Account label the address should be associated with. Defaults to general when omitted. Case sensitive; must match the letters-numbers-_---: pattern and be at most 40 characters.

Example request

{
  "participant_code": "ABCDEF",
  "asset": "BTC",
  "account_label": "general"
}

Response

Successfully created deposit address. Returns the created resource with generated IDs and timestamps.

Example response

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

Changes

    • breaking

      request property was restricted to a list of enum values

    • info

      added the new AAVE enum value to the request property

    • info

      added the new ADA enum value to the request property

    • info

      added the new ALGO enum value to the request property

    • info

      added the new AVAX enum value to the request property

    • info

      added the new BAT enum value to the request property

    • info

      added the new BCH enum value to the request property

    • info

      added the new BTC enum value to the request property

    • info

      added the new BUSD enum value to the request property

    • info

      added the new COMP enum value to the request property

    • info

      added the new DAI enum value to the request property

    • info

      added the new DOGE enum value to the request property

    • info

      added the new DOT enum value to the request property

    • info

      added the new EGLD enum value to the request property

    • info

      added the new EOS enum value to the request property

    • info

      added the new ETC enum value to the request property

    • info

      added the new ETH enum value to the request property

    • info

      added the new ETH.ARBITRUM enum value to the request property

    • info

      added the new GRT enum value to the request property

    • info

      added the new GYEN enum value to the request property

    • info

      added the new HBAR enum value to the request property

    • info

      added the new LINK enum value to the request property

    • info

      added the new LTC enum value to the request property

    • info

      added the new LUNA enum value to the request property

    • info

      added the new MATIC enum value to the request property

    • info

      added the new MATIC.POLYGON enum value to the request property

    • info

      added the new MKR enum value to the request property

    • info

      added the new MOB enum value to the request property

    • info

      added the new SAND enum value to the request property

    • info

      added the new SOL enum value to the request property

    • info

      added the new UNI enum value to the request property

    • info

      added the new USDC enum value to the request property

    • info

      added the new USDC.ALGO enum value to the request property

    • info

      added the new USDC.AVAX enum value to the request property

    • info

      added the new USDC.HBAR enum value to the request property

    • info

      added the new USDC.POLYGON enum value to the request property

    • info

      added the new USDC.SOL enum value to the request property

    • info

      added the new USDC.XLM enum value to the request property

    • info

      added the new USDT enum value to the request property

    • info

      added the new UST enum value to the request property

    • info

      added the new WBTC enum value to the request property

    • info

      added the new XEM enum value to the request property

    • info

      added the new XLM enum value to the request property

    • info

      added the new XRP enum value to the request property

    • info

      added the new XTZ enum value to the request property

    • info

      added the new ZUSD enum value to the request property