Endpoints Overview

The complete endpoint map — customers, earning, spending, corrections, settings and referrals — each linked to its technical specification

This is the bridge page for your developers: every operation in the platform, in one list, each linking to its full technical specification — request formats, responses, error codes, and a live test client.

Two references

Everything a till, website or app integrates with lives in the [Loyalty reference on Scalar](https://prod.freecustomer.in/api/v2/docs#tag/loyalty). The referral operations used by your staff console and public forms are documented in the [full platform reference](https://prod.freecustomer.in/api/docs) under Loyalty Referral.

Customers

Operation	What it does
Look up customer	Fetch a customer's profile by phone
Add customer	Register a customer — harmless if they already exist
Points summary	Balance, holds, locked points and lifetime totals

Earning

Operation	What it does
Create rule	Define an earning rule
List rules	Every rule for the tenant, highest priority first, with conditions and actions
Read a rule	One rule in full
Update a rule	Replace a rule's definition — conditions and actions are replaced wholesale
Change rule status	Activate, pause, archive or restore a rule
List archived rules	Retired rules — they keep their history and can be restored
Rule statistics	Execution counts and points awarded per rule over a recent window (30 days by default)
Calculate points	Work out what a transaction earns — without awarding yet

Spending

Operation	What it does
Request redemption	Start a redemption and place the points on hold
Validate code	Check the customer's one-time code
Resend code	Void old codes and send a fresh one
Release redemption	Cancel a pending redemption and free its points

Completing & Correcting

Operation	What it does
Confirm	Make a calculated earning or redemption final — optionally sending the customer message in the same call
Send notification	Deliver the prepared WhatsApp message — once
Reverse points	Undo a transaction; the platform picks the right method
Grant bonus	Credit goodwill points as a standalone entry, with a reason
Apply penalty	Debit points as a penalty, honouring your discretionary-debit policy
Adjust points	A manual correction in either direction, keyed by an operation code

Settings

Every section of the loyalty settings can be read and changed by an administrator over the API — the same sections the Settings page shows in the app.

Operation	What it does
Read settings	The effective configuration, grouped by section
Update redemption settings	Availability, confirmation window, caps, fraud limits, reversal and debit policies
Update OTP settings	Whether redemptions need a code, how long it lives, and whether it goes by WhatsApp or SMS
Update accrual settings	Point lifetime and waiting-period defaults, rounding, rule-match limit, tiers
Update earning caps	Percentage-of-bill and fixed-amount ceilings and how they combine
Update notification templates	Which WhatsApp template announces each loyalty event
List centres	The centres points can be attributed to
Update centres	The centre list and whether points are ring-fenced to the centre that issued them
Update referral channels	The capture channels a referral program can pick from

Referrals

Referral operations are versioned under /api/v1/loyalty/referral and use the same authenticated channel as the rest of the platform. Lists — programs, leads, the review queue, analytics — are streamed to the app over its live connection rather than fetched over REST.

Operation	Path	What it does
Create program	`POST /programs`	A blank program with a name, optional description, code format and per-channel approval rules
Update program settings	`PUT /programs/{program_uuid}`	Dates, attribution window, channels, approval behaviour, lifecycle behaviour, tag rules and more
Replace the journey	`PUT /programs/{program_uuid}/journey`	The ordered milestones with their events, conditions and rewards
Change program status	`POST /programs/{program_uuid}/status`	Draft → Active → Paused → Ended
Update referral settings	`PUT /settings`	Tenant-wide referral behaviour — approval, consent, windows, lifecycle defaults
Onboard a referrer	`POST /referrers`	Enrol a member in a program and issue their code
Look up referrers	`GET /referrers`	Find enrolments by code, phone or lead
Revoke a referrer	`POST /referrers/{referrer_uuid}/revoke`	Retire a code
Capture a referee	`POST /captures`	Add a referred lead against a code or a program
Capture a referee (public)	`POST /api/v1/public/loyalty/referral/captures`	The same capture from a public web form, authenticated with a static token
Ingest a business event	`POST /events`	Tell the platform something happened to a referee — registration, booking, billing
Event definitions	`POST`, `PUT`, `DELETE /event-definitions`	The catalogue of events your milestones can react to
Record consent	`POST /consent/{lead_uuid}` and `/otp/send`, `/otp/validate`	Record, withdraw or OTP-verify a referee's consent
Resolve a review	`POST /reviews/{review_uuid}/resolve`	Approve or reject a conflict, fraud, attribution or milestone review
List capture channels	`GET /capture-channels`	The tenant's channel list, for pickers
Fraud settings	`PUT /api/v1/loyalty/fraud/config`	The referral fraud rules the engine reads at reward time

The complete technical reference, in one place: Loyalty on Scalar and the full platform reference.