Send Rewards from Server

Use your API key to send rewards securely from your backend using the Earn API (v2).

POST /api/v2/rewards/limited-achievement/reward

Send Rewards from Server

cURL

curl --request POST \
  --url https://api.zbdpay.com/api/v2/rewards/limited-achievement/reward \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "rewardsUserId": "<string>",
  "amount": 123
}
'

201 - Success

{
  "success": true,
  "message": "Success.",
  "data": [
    {
      "transactionId": "f7553b31-5ae2-43bf-a200-c0a966e94071"
    }
  ]
}

Send rewards securely from your backend using the ZBD Earn API (v2). This method ensures all rewards are issued from a trusted environment, preventing client-side abuse and maintaining full control over reward distribution.

Reward Unit Configuration. The reward unit (e.g., 1 satoshi or $0.10) is defined for your game by your ZBD Customer Success Manager.

Configuration

Header Parameters

x-api-key · string · required

API key used for authentication. Obtain this from the Create an API Key step.

Body Parameters

rewardsUserId · string · required

The recipient’s ZBD Rewards User ID

amount · number · required

Reward amount in configured units

Example: 10 (units defined by your ZBD Customer Success Manager)

201 - Success

{
  "success": true,
  "message": "Success.",
  "data": [
    {
      "transactionId": "f7553b31-5ae2-43bf-a200-c0a966e94071"
    }
  ]
}

Response Status Codes

Code	Description
201	Reward sent successfully
400	Bad request – invalid parameters
401	Unauthorized – invalid or missing API key
404	Rewards user not found
500	Internal server error

400 - Bad Request

{
  "success": false,
  "message": "Invalid parameters"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request was successful
message	string	Response message
data	array	Array containing transaction details
transactionId	string	Unique transaction identifier

---

Security Reminder, Never expose your API key in client-side code. Always send rewards from your backend server where your API key is securely stored.

Code Examples

Node.js

const apiKey = process.env.REWARDS_API_KEY;

async function sendReward(rewardsUserId, amount) {
  const response = await fetch('https://api.zbdpay.com/api/v2/rewards/limited-achievement/reward', {
    method: 'POST',
    headers: {
      'x-api-key': apiKey
    },
    body: JSON.stringify({
      rewardsUserId,
      amount
    })
  });

  const data = await response.json();

  if (data.success) {
    console.log(`Reward sent! Transaction ID: ${data.data[0].transactionId}`);
    return data.data[0];
  } else {
    throw new Error(`Failed to send reward: ${data.message}`);
  }
}

// Example: Send 10 reward units
await sendReward('f2154d1a-67e6-46f2-b293-b4b226948dc9', 10);

Try It Out

Ready to send your first reward from the server? Use our API playground on the right to test with your API key.