Get Points Balance
Retrieve the current points balance, tier status, and related information for a specific loyalty card. This endpoint provides real-time balance data including tier progress and available benefits.Balance information is updated in real-time and includes pending transactions that may affect the final balance.
Path Parameters
Language code for localized content (e.g., βenβ, βltβ)
Unique identifier of the loyalty card to check balance for
Response
Indicates if the request was successful
Human-readable message about the operation
Tier System Overview
The loyalty program uses a 4-tier system with increasing benefits:Requirements: 0-499 points lifetime earnedBenefits:
- Standard point earning rate (1x)
- Basic customer support
- Monthly newsletter
Balance Management
Point Expiration: Points typically expire 12 months after earning. The
expires_soon
field shows points expiring within 30 days, allowing users to plan redemptions accordingly.Balance Calculation Priority
- Current Points: Immediately available for redemption
- Pending Points: From recent transactions (processing)
- Expiring Points: Highlighted for user attention
Real-time Updates
Balance information reflects:- β Completed point awards and redemptions
- β³ Pending transactions (shown separately)
- π Upcoming expirations
- π Tier progress calculations