Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Awards

Fund awards account

Define the quantity, quoted currency, and asset that you plan to distribute to customers through the POST /awards/distribute endpoint.

post/awards/fund

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

OR

Example request

{
  "underlying": "BTC",
  "quoted_currency": "USD",
  "quantity": "1.00"
}

Response

Successfully funded awards account. Returns the executed quote and booked trade identifiers.

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": [
      "ba97133e-ab15-4c86-86c1-86671b8420bc",
      "ce819fe8-b1d7-43bb-961c-e09ede0988d3"
    ],
    "status": "Completed"
  }
}