Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Rewards

Disperse rewards

Completes a transaction involving a designated asset and disperses rewards.

post/rewards

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.

X-Request-Idstring uuid

Optional client-supplied request ID used for tracing and idempotency. Must be a UUID v4. When omitted, zerohash generates one and returns it in the response X-Request-Id header.

Request body

underlying'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' required

the underlying asset

quoted_currency'CAD' | 'EUR' | 'GBP' | 'JPY' | 'MXN' | 'USD' required

the quoted asset

quantitystring

the desired amount of the underlying for the quote (either quantity or total must be provided)

totalstring

the desired amount of the quoted_currency for the quote (either quantity or total must be provided)

participant_codestring required

the participant that is receiving the reward. This is the platform's customer.

account_labelstring

the account label associated with the account

Example request

{
  "underlying": "BTC",
  "quoted_currency": "USD",
  "quantity": "1",
  "total": "11430.90",
  "participant_code": "CUST01",
  "account_label": "sub_account_test"
}

Response

Successfully dispersed reward. Returns the executed quote, the booked trade identifiers, and the asset cost notional.

Example response

{
  "message": {
    "request_id": "14f8ebb8-7530-4aa4-bef9-9d73d56313f3",
    "quote": {
      "request_id": "ce819fe8-b1d7-43bb-961c-e09ede0988d3",
      "participant_code": "CUST01",
      "quoted_currency": "USD",
      "side": "buy",
      "quantity": "1",
      "price": "11430.90",
      "quote_id": "32ad471b-824e-4f04-94ff-45c4439b4fe9",
      "expire_ts": 1568311649602,
      "account_group": "GRP001",
      "account_label": "sub_account_test",
      "obo_participant": {
        "participant_code": "20XRLH",
        "account_group": "WRD1K0",
        "account_label": "general"
      },
      "total_notional": "2.00",
      "underlying": "BTC",
      "asset_cost_notional": "2.00",
      "spread_notional": "2.12",
      "spread_bps": "50",
      "commission_notional": "5.00",
      "commission_bps": "25"
    },
    "trade_id": "ba97133e-ab15-4c86-86c1-86671b8420bc",
    "trade_ids_list": [
      "22555492-50e4-4741-a632-2419a1f9a3f4",
      "1ed1baf6-8a12-45bc-96db-4719cf2ddcab"
    ],
    "status": "Completed",
    "asset_cost_notional": "3.00"
  }
}