What are Loyalty Cards?
Loyalty cards identify customers in ClearLine’s loyalty program. Using these endpoints, you can:- Look Up Cards: Find customer loyalty information by card number, phone, or email
- Check Balances: View current points, stamps, or reward status
- Add Points: Award loyalty points or stamps for purchases
- Validate Cards: Verify card status and program eligibility
How It Works
Customer Identifies Themselves
Customer provides loyalty card number, phone number, or email at checkout.
Look Up Loyalty Information
Use lookup
endpoints
to retrieve customer’s loyalty details and current balance.
Process Transaction & Award Points
Complete the sale and use add points
endpoint to
award loyalty rewards.
Loyalty Card Endpoints
Lookup Loyalty Card
Find customer by card number, phone, or email (V2)
Lookup Loyalty Users
Search for customers in the loyalty program (V2)
Add Loyalty Amount
Award points or stamps to a customer’s card (V2)
Get User Card Details
Retrieve detailed loyalty card information (V1)
Get Cards by Location
List all loyalty cards for a location (V1)
Best Practices
Support Multiple Lookup Methods
Support Multiple Lookup Methods
Allow customers to identify themselves by card number, phone, or email. Not
all customers remember their card number.
Display Balance Clearly
Display Balance Clearly
Show current points/stamps balance and progress toward next reward to
encourage continued participation.
Award Points Immediately
Award Points Immediately
Call the add points endpoint immediately after transaction completion so
customers see their balance update in real-time.
Handle Inactive Cards
Handle Inactive Cards
Check card status in lookup response. Inactive or expired cards should
prompt customer to reactivate through the app or website.
Cache User Data Briefly
Cache User Data Briefly
Cache loyalty card details for the duration of the transaction only. Don’t
store sensitive customer data long-term on POS terminals.
Loyalty Program Types
ClearLine supports different loyalty program structures:- Points-Based: Customers earn points per dollar spent (e.g., 1 point = $1)
- Stamp Cards: Collect stamps per visit or purchase (e.g., 10 stamps = free item)
- Tiered Programs: Different reward levels based on spending (Bronze, Silver, Gold)
- Hybrid Programs: Combination of points, stamps, and tier benefits