Awards
Awards
These endpoints can be used to facilitate Awards payments as part of a promotional program, prize pool, bonus pool, giveaway, etc. See release notes here for more information
POST /awards/fund
POST /awards/fund
Specify the amount, quoted currency, and asset that you intend to ultimately distribute to your customers via the POST /awards/distribute endpoint.
const fundAwards = (asset: string, notional: string) => {
const body = `{
asset: ${asset},
total: ${notional}
}`
const timestamp = Math.round(Date.now() / 1000)
const payload = timestamp + 'POST' + '/awards' + body
const decodedSecret = Buffer.from(apiSecret, 'base64')
const hmac = crypto.createHmac('sha256', decodedSecret)
const signedPayload = hmac.update(payload).digest('base64')
// SET HEADERS
const headers = {
'X-NDAX-API-KEY': 'public_key',
'X-NDAX-SIGNED': signedPayload,
'X-NDAX-TIMESTAMP': timestamp,
'X-NDAX-PASSPHRASE': 'passphrase'
}
const options = {
headers,
body,
json: true
}
return request.post(`https://api.ndax.in/awards/fund`, options)
}
Sample Response
{
"request_id": "14f8ebb8-7530-4aa4-bef9-9d73d56313f3",
"quote": {
"request_id": "ce819fe8-b1d7-43bb-961c-e09ede0988d3",
"participant_code": "CUST01",
"underlying_currency": "BTC",
"quoted_currency": "e₹",
"side": "BUY",
"quantity": "1",
"price": "11430.90",
"quote_id": "5cd07738b861c31e3bd61467BTC1Buy1568311644602",
"expire_ts": 1568311649602,
"transaction_timestamp": 1568311649600
},
"trade_id": "ba97133e-ab15-4c86-86c1-86671b8420bc",
"status": "Completed"
}
Body parameters include:
underlying
(required) the underlying asset for to be awarded.quoted_currency
(required) the quoted asset for purchase of the rewardquantity
(optional) the desired amount of theunderlying
for the quote (eitherquantity
ortotal
must be provided)total
(optional) the desired amount of thequoted_currency
for the quote (eitherquantity
ortotal
must be provided)
Response:
request_id
The identifier of the RFQ
string
quote
The quote object that was executed
quote
trade_id
The unique identifier assigned to the trade, which is the same trade_id
as found in a GET /trades
request
Note: the quote_id
will be saved as the client_trade_id
string
status
The status of the trade, e.g. Completed
string
POST /awards/distribute
POST /awards/distribute
Evenly distribute the purchased crypto among the specified customers.
const distributeAwards = (asset: string, quantity: string, customer_participant_codes: string[]) => {
const body = `{
asset: ${asset},
quantity: ${quantity}
participant_codes: ${customer_participant_codes}
}`
const timestamp = Math.round(Date.now() / 1000)
const payload = timestamp + 'POST' + '/awards' + body
const decodedSecret = Buffer.from(apiSecret, 'base64')
const hmac = crypto.createHmac('sha256', decodedSecret)
const signedPayload = hmac.update(payload).digest('base64')
// SET HEADERS
const headers = {
'X-SCX-API-KEY': 'public_key',
'X-SCX-SIGNED': signedPayload,
'X-SCX-TIMESTAMP': timestamp,
'X-SCX-PASSPHRASE': 'passphrase'
}
const options = {
headers,
body,
json: true
}
return request.post(`https://api.zerohash.com/awards/distribute`, options)
}
Sample Response
{
"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",
},
]
}
Body parameters include:
asset
(required) the asset for to be awarded.quantity
(required) the desired amount of theasset
for to be awarded to each customer in the requestparticipant_codes
(required) the list of customers to receivequantity
amount of reward
Response:
request_id
The identifier of the request
string
confirms
A list of participant_code plus trade identifiers for the executed trades confirm
confirm
Last updated