Overview
Concepts
Understand the core concepts of the Raba7ni platform and how they work together.
Core Entities
Members
Members are your customers who participate in your loyalty program. Each member:
- Has a unique email and/or phone number
- Can be associated with multiple loyalty cards
- Earns and redeems points through transactions
- Can refer other members for bonus points
Loyalty Cards
Cards define your loyalty programs. Each card has:
- Points Rules - How many points per currency unit spent
- Rewards - What members can redeem points for
- Members - Who is enrolled in this loyalty program
Transactions
Transactions record point activity:
| Type | Description | Points Effect |
|---|---|---|
| Earn | Points earned from purchases | + Points |
| Redeem | Points used for rewards | - Points |
| Bonus | Promotional or referral points | + Points |
| Adjustment | Manual corrections by staff | +/- Points |
Typical API Flow
1
Validate Member
Check if a phone number or email belongs to an existing member of your loyalty card.
2
Find or Create
If member exists, retrieve their data. If not, create a new member with OTP verification.
3
Award Points
Create an order and award points based on purchase amount using your card's earn rules.
4
Handle Redemptions
Process claim requests when members want to redeem their points for rewards.
Referral System
Members can refer others using unique referral codes:
- Referrer - The existing member who shares their code
- Referee - The new member who uses the code
- Both parties receive bonus points when the referral is completed
Referral Points
The bonus points for referrer and referee are configured per card in your partner dashboard.