Developers
V1RewardsPoints

Your private append-only reward points history

GET
/v1/rewards/points

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

filter?string
Default"all"

Value in

  • "all"
  • "earned"
  • "spent"
cursor?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
limit?integer
Range1 <= value <= 50
Default30

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/rewards/points"
{  "availablePoints": 0,  "entries": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "at": "2019-08-24T14:15:22Z",      "delta": -9007199254740991,      "reason": "earning"    }  ],  "nextCursor": "53a4a333-2825-45a4-80d2-5f430d088f36"}

Validate a reward proof as active merchant owner/staff POST

Requires a Better Auth session and an active merchant owner/staff role checked from the database. Corporate users and unrelated merchants have no access; a live platform admin role does not bypass merchant membership. Optional outletId records the branch of the redemption (409 reward_wrong_outlet when the voucher does not work there). Returns no customer account, name, phone, identity-document or health data. Repeated collection returns already_redeemed.

Search and page through published reward campaigns GET

Next Page