Loyalty Features

The Loyalty API supports multiple loyalty mechanics. Each mechanism is designed to drive engagement, retention, and reward behavior in a flexible and scalable way.

warning

Always fetch real-time member data via /member/details before applying loyalty logic. Never cache eligibility or balances.

Feature Summary

Feature	Description	Key Endpoints	Notes
Points	Earned depending to rules which are defined in the business's campaign; can be used for payment or gift redemption.	/transaction, /payment, /member/details	May work like cash; often used for refunds or top-ups, depending on business rules or configuration.
Credit	Store-value balance; usable for purchases, refunds, or bonuses.	/payment, /member/details	May work like cash; often used for refunds or top-ups, depending on business rules or configuration.
Gifts	One-time redeemable assets such as vouchers or welcome offers.	/member/details, /transaction	Sent in usedAssets; each has rules (e.g. expiration, one-time use).
Deals	Automatic, reusable discounts based on eligibility or campaigns.	/member/details, /transaction	Returned in appliedDeals; set x-return-benefits: true.
Registration	Adds new members to the program with required information and preferences.	/member/register	Fields like phoneNumber, gdpr, termsOfUse required.
Profile Update	Modify existing member fields or preferences.	/member/update	Send only changed fields; secure and atomic updates.
Member Lookup	Retrieve full profile data and preview benefits.	/member/details	Use before applying benefits or loyalty logic.
Short Code	Generate/verify temporary codes for kiosk or embedded login.	/member/shortCode	Supports phone or email; used in secure flows.
Events	Record behavior like visits, referrals, and check-ins to trigger rewards or campaigns.	/event	Includes type, subType, payload, tags.