Get Earning Rule Details

GET

/merchant/rules/{id}

Retrieves the details of a single earning rule by its ID, including usage statistics (users_rewarded count).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Earning rule details retrieved successfully.

Body

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/merchant/rules/42' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Earning rule 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-02-25 12:17:15

List Earning Rules

Get IP Whitelist