List Earning Rules
Development Server
https://rewrd-api-staging.fly.dev/v1
Development Server
https://rewrd-api-staging.fly.dev/v1
GET
/merchant/rules
Earning rules define the logic for how customers earn points. You create them in the Rewrd Dashboard, and then reference them by
id when processing transactions via the POST /points/transaction endpoint.earning_type:| Earning Type | How points are calculated | Example |
|---|---|---|
fixed | Awards a flat number of points regardless of order value | Rule says 50 points → Customer always gets 50 points, whether they spend ₦1,000 or ₦100,000 |
percentage_off | Awards points as a percentage of the order value | Rule says 10% → Customer spends ₦5,000, earns 500 points |
users_rewarded, which is the total number of times it has been used to award points — useful for seeing which rules are most popular.Request
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rewrd-api-staging.fly.dev/v1/merchant/rules' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Example 1
{
"status": true,
"message": "Earning rules retrieved successfully",
"data": [
{
"id": 42,
"merchant_id": "merch_xyz789",
"name": "Purchase Reward",
"points": 50,
"type": "purchase",
"subtype": "string",
"status": "active",
"users_rewarded": 1523,
"deleted": false,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"earning_type": "fixed",
"percentage_off": 10
}
]
}Modified at 2026-04-07 21:05:20