Send Reward API

Send a digital reward to a recipient.

Endpoint: POST /v1/rewards/send

Headers

Name	Type	Required	Description
x-api-key	string	Yes	Your API key
Content-Type	string	Yes	Must be application/json

Request Body

{
  "rewardCode": "AMAZON-US",
  "rewardName": "Amazon Gift Card",
  "amount": "50.00",
  "recipientEmail": "recipient@example.com",
  "quantity": 1,
  "currency": "USD"
}

Parameters

Parameter	Type	Required	Description
rewardCode	string	Yes	Unique identifier for the reward type
rewardName	string	Yes	Display name of the reward
amount	string	Yes	Amount for each reward
recipientEmail	string	Yes	Email address of the recipient
quantity	number	No	Number of rewards to send (default: 1)
currency	string	Yes	Currency code (e.g., USD, GBP)

Response

{
  "success": true,
  "orderId": "ord_123abc",
  "amount": 50.00,
  "currency": "USD"
}

Example Request

curl -X POST 'https://api.example.com/v1/rewards/send' -H 'x-api-key: rpl_your_api_key' -H 'Content-Type: application/json' -d '{
  "rewardCode": "AMAZON-US",
  "rewardName": "Amazon Gift Card",
  "amount": "50.00",
  "recipientEmail": "recipient@example.com",
  "quantity": 1,
  "currency": "USD"
}'

Error Codes

Status	Code	Description
400	invalid_request	Invalid request parameters
400	insufficient_balance	Organization has insufficient balance
401	unauthorized	Invalid or missing API key
404	not_found	Reward code not found
500	server_error	Internal server error

Order Status

After sending a reward, the order will go through the following statuses which you can check in your dashboard.

Status	Description
processing	Initial state when order is created
completed	Reward has been successfully delivered
failed	Order failed to process

When an order is completed, the recipient will receive an email with their reward details.