Rewrd API
  1. Points
Rewrd API
  • Customers
    • Create or Update a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • Update a Customer
      PUT
    • Restrict a Customer
      PATCH
    • Unrestrict a Customer
      PATCH
  • Merchant
    • Get Merchant Configuration
      GET
    • Update Merchant Configuration
      PATCH
    • List Earning Rules
      GET
    • Get Earning Rule Details
      GET
    • Get IP Whitelist
      GET
    • Update IP Whitelist
      PUT
    • Get Merchant Analytics
      GET
  • Points
    • Credit Points to a Customer
      POST
    • Redeem Points
      POST
    • Get Customer Transaction History
      GET
  1. Points

Credit Points to a Customer

POST
/points/credit
Awards loyalty points to a customer's account. The specified number of points is added to the customer's balance and deducted from your merchant point pool.
Earning Rule Association (optional):
You can associate the credit with an earning rule by providing a rule_id. This links the transaction to the rule for analytics and automatically uses the rule's name and type in the transaction record. The rule must be active and not deleted.
Webhooks:
A points.earned webhook event is fired after a successful credit, containing the customer_uid, points, rule_id, and ledger_id.
This endpoint requires an Idempotency-Key header to prevent duplicate credits.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Points credited successfully. Returns the created ledger entry.
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/points/credit' \
--header 'Idempotency-Key: credit-cust123-20260225-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_uid": "cust_abc123def456",
    "points": 50,
    "rule_id": 42,
    "narration": "Reward for purchase #12345",
    "order_id": "order_98765"
}'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Points credited successfully",
    "data": {
        "id": 1284,
        "merchant_id": "merch_xyz789",
        "customer_uid": "cust_abc123def456",
        "amount": 50,
        "transaction_type": "member_points_adjustment_credit",
        "reference_id": "credit_a1b2c3d4-e5f6-7890",
        "title": "Points Credit",
        "narration": "Credited 50 points for purchase #12345",
        "balance_after": 1550,
        "created_at": "2026-02-20T14:30:00.000Z"
    }
}
Modified at 2026-02-25 12:17:15
Previous
Get Merchant Analytics
Next
Redeem Points
Built with