Settings Reference

Every loyalty setting, tab by tab as the app shows them — Redemption, OTP, Accrual, Notifications, Centres, Earning caps and Referral

Every behavioral switch in the platform is tenant configuration — changed by an administrator under Settings → Loyalty in the app (or over the API), never hardcoded and never requiring a deployment. Each tab saves on its own with Save changes; this page catalogues every choice by the tab it lives on, and the linked pages go deeper on each area.

Loyalty itself is set up by your account team

A tenant with no loyalty configuration reads every value below as its default and refuses to save changes. Once the configuration exists, everything on this page is yours to change.

Redemption

Setting	Your options	Default
Loyalty is switched on	The master switch. Off stops everything — no earning, no redeeming, no reversals, no uploads. Points already earned stay where they are	Off
Hold points for	Minutes a started redemption reserves the points before releasing them — the confirmation window	10
Message the member	Sends the redemption confirmation on WhatsApp as soon as it completes	Off
Maximum points per redemption	A ceiling on a single redemption; blank for no limit	None
Ceilings by tier	Overrides the figure above for the tiers you list	None
Daily guards — points per redemption, redemptions per day, points per day	Per-member limits that catch a compromised account before it drains a wallet; blank for no limit	None
Taking points back — reversing a redemption	Oldest points first on / off; if the balance is short: refuse the debit, take what is available, or allow a negative balance, with a lowest balance	Refuse
Taking points back — removing points by hand	The same three choices for penalties and manual adjustments made by an agent	Refuse

See Redemption Flow, Fraud & Usage Limits and Reversal Levels.

OTP

Setting	Your options	Default
Ask for a one-time code	Applies to every redemption, including ones started at the counter	Off
How the code is sent	WhatsApp, through one of your approved templates / SMS, through a gateway your operator has approved	WhatsApp
Message that carries the code	The WhatsApp template the code is sent in — pick one, or every redemption is refused	—
Gateway that sends the code	The SMS gateway (QikBerry); Add gateway takes the API key, the sender id, the DLT template id and the registered message with `{otp}` where the code goes	—
Code valid for	Minutes before the member has to ask for a new one	10

See OTP Validation.

Accrual

Setting	Your options	Default
Points expire after	A duration in seconds, minutes, hours or days, counted from the moment points are earned; applies to points from any rule that does not set its own expiry	1 year
Spendable after	A delay before earned points can be used; blank makes them spendable immediately	Immediately
Stop after this many rules match	Rules run highest priority first; blank lets every matching rule pay out	All
Round awarded points	Keeps awarded points whole — Round at each rule award, or once on the transaction total	Off
Event ceilings	The most a member can earn from one kind of event, however many rules match it	None
Earning multiplier	Applied to every award for members in that tier	Base rate
Earning ceiling	The most a tier can earn	None
Tier for members with none	Used when a member has no tier set	—

See Earning Rules, Maturity & Expiry and Tiers & Multipliers.

Notifications

One section per loyalty event: the Message (a WhatsApp template, or send nothing), the Days it may go out, Any time of day or a Send between window. Add an event announces another loyalty event. See Notifications.

Centres

Setting	Your options	Default
Keep points at the centre that issued them	Once on, every reward and redemption must name a centre; points earned before the change carry no centre and stay spendable anywhere	Off
Unit shown when a transaction has no centre	What app orders and other centre-less transactions show in the points logs	Blank
Centres	Centre name and code, one row each — the code is what your billing system sends	Empty

See Centres & Store Separation.

Earning Caps

Two independent cap families bound what a transaction can award, plus your choice of how they combine. Every trim is recorded transparently so the arithmetic stays auditable.

Setting	Your options
Cap points as a share of the bill	Off, or on with a Share of the bill (%) as the default ceiling for every member, overridden By tier, By category, By payment method and By channel
Cap points by amount	Off, or on with fixed ceilings Per transaction, Per day and Per month, plus overrides By tier and By category; blank means no limit
Combine caps by	No cap / Percentage cap only / Amount cap only / Both — whichever caps lower / Both — whichever caps higher

A tenant that never saved caps earns uncapped.

Referral

Capture channels — the list a referral program picks from and every capture names. The rest of the referral behaviour lives on each program and on Settings → Fraud rules; see Referral Settings.

Defaults are deliberately restrictive

A fresh tenant has everything off: loyalty off, no OTP, take-backs refused, no caps configured, no centres, no channels defined. You opt into each capability explicitly.

For developers

Read everything with [read settings](https://prod.freecustomer.in/api/v2/docs#tag/loyalty/GET/api/v2/loyalty/configuration) and write a section at a time with the `PATCH /api/v2/loyalty/configuration/…` endpoints — each is a partial update, so send only the fields you are changing. Durations are stored in seconds; the app converts.