Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Awards

Distribute awards

Evenly distribute the purchased crypto among the specified customers.

post/awards/distribute

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

asset'USDC.OPTIMISM' | 'USDC.SUI' | 'DOT' | 'FIL' | 'PYUSD.ETH' | 'TRX' | 'ZRX' | 'DAI.ETH' | 'USDC.WORLDCHAIN' | 'USDP' | 'USDT.BSC' | 'USDT.CELO' | 'PEPE.ETH' | 'SAND' | 'USDC.DOTHUB' | 'USDC.SEI' | 'USDC.SOL' | 'USDC.ZKSYNC' | 'ENA.ETH' | 'MANA.ETH' | 'PYTH.SOL' | 'SOL' | 'USDC.BASE' | 'USDC.CELO' | 'USDT' | 'ADA' | 'INJ.ETH' | 'MATIC.POLYGON' | 'PAXG' | 'USD' | 'AAVE.ETH' | 'ALGO' | 'EURC.XLM' | 'KNC.ETH' | 'PNUT.SOL' | 'SHIB' | 'BCH' | 'DOGE' | 'EGLD' | 'JTO.SOL' | 'UNI.ETH' | 'USDC' | 'USDC.ARBITRUM' | 'ONDO.ETH' | 'PENGU.SOL' | 'USD' | 'WLFI.ETH' | 'XLM' | 'APT' | 'CC' | 'ETH.OPTIMISM' | 'ETH.WORLDCHAIN' | 'LDO.ETH' | 'MORPHO.ETH' | 'SEI' | 'ETH.ZKSYNC' | 'USDC.AVAX' | 'USDC.XLM' | 'USDT.DOTHUB' | 'USDT.SOL' | 'MANA' | 'USDC.ALGO' | 'MATIC.ETH' | 'NEAR' | 'UNI' | 'USDT.ARBITRUM' | 'USDT.AVAX' | 'OMG' | 'ARB.ARBITRUM' | 'COMP.ETH' | 'GRT.ETH' | 'USDC.POLYGON' | 'AVAX' | 'AAVE' | 'CELO' | 'PYUSD.SOL' | 'PAXG.ETH' | 'USDC.MONAD' | 'BAT' | 'COMP' | 'ETH.ARBITRUM' | 'ETH.BASE' | 'OP.OPTIMISM' | 'TRUMP.SOL' | 'ENJ.ETH' | 'SUI' | 'USDT.ETH' | 'USDT.OPTIMISM' | 'USDT.TRX' | 'USDT.XPL' | 'OMG.ETH' | 'XRP' | 'HBAR' | 'USDC.APT' | 'USDC.ETH' | 'BNB' | 'ATOM' | 'BAT.ETH' | 'GRT' | 'LINK.ETH' | 'USDP.SOL' | 'ZK.ZKSYNC' | 'BONK.SOL' | 'KNC' | 'TIA' | 'ZRO.ETH' | 'ZRX.ETH' | 'PUMP.SOL' | 'USD' | 'XTZ' | 'CRV.ETH' | 'GALA.ETH' | 'TON' | 'USDT.POLYGON' | 'WBTC.ETH' | 'XPL' | 'BTC' | 'MON' | 'SHIB.ETH' | 'USDC.BSC' | 'WLD.WORLDCHAIN' | 'W.SOL' | 'LTC' | 'RLUSD.ETH' | 'WBTC' | 'LINK' | 'USDCX.CANTON' | 'ETH' | 'WIF.SOL' | 'APE.ETH' | 'EURC' | 'MKR.ETH' | 'RLUSD.XRP' required

The underlying asset in the trading pair. E.g. BTC in the pair BTC/USD.

quantitystring required

The quantity of the underlying asset requested in the quote. Exactly one of quantity or total must be supplied.

participant_codesstring[] required

The list of customers to receive quantity amount of reward

quoted_currency'USD' | 'EUR' required

The quoted currency in the trading pair. E.g. USD in the pair BTC/USD.

Example request

{
  "asset": "BTC",
  "quantity": "1.00",
  "participant_codes": [
    "CUST01",
    "CUST02"
  ],
  "quoted_currency": "USD"
}

Response

Successfully distributed awards. Returns a confirmation per participant containing the booked trade_id.

Example response

{
  "message": {
    "request_id": "14f8ebb8-7530-4aa4-bef9-9d73d56313f3",
    "confirms": [
      {
        "participant_code": "CUST01",
        "trade_id": "ce819fe8-b1d7-43bb-961c-e09ede0988d3"
      },
      {
        "participant_code": "CUST02",
        "trade_id": "ba97133e-ab15-4c86-86c1-86671b8420bc"
      }
    ]
  }
}