Redeem Points

POST

/points/redeem

Deducts loyalty points from a customer's account for a redemption. The specified number of points is subtracted from the customer's balance and added back to your merchant point pool.

Balance checks:

The customer must have sufficient points balance to cover the redemption.

The customer must meet the configured minimum threshold amount for redemption.

The customer must be in active status (not restricted).

Webhooks:
A points.redeemed webhook event is fired after a successful redemption, containing the customer_uid, points, reward_id, and ledger_id.

This endpoint requires an Idempotency-Key header to prevent duplicate redemptions.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Points redeemed successfully. Returns the created ledger entry.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/points/redeem' \
--header 'Idempotency-Key: redeem-cust123-20260225-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_uid": "cust_abc123def456",
    "points": 200,
    "reward_id": "reward_coffee_free",
    "narration": "Redeemed for free coffee"
}'

Response Example

200 - Example 1

{
    "status": true,
    "message": "Points redeemed 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

Credit Points to a Customer

Get Customer Transaction History