List Earning Rules

GET

/merchant/rules

Retrieves all active (non-deleted) earning rules for your merchant account.

Earning rules define how customers earn points. Each rule has a name, point value, and type. Use the rule id when crediting points via the POST /points/credit endpoint to automatically associate the credit with the rule.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Responses

🟢200OK

application/json

Earning rules retrieved successfully.

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

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-02-25 12:17:15

Update Merchant Configuration

Get Earning Rule Details