Skip to content

Redeem Points

POST /members/{id}/redeem command bearer

Redeems loyalty points as a payment tender during checkout. Validates balance and applies redemption rules.


Overview

ID redeem-points-api
Method POST
Path /members/{id}/redeem
Classification command
Domain loyalty
Capability loyalty
Service redeem-points
Application loyalty-platform — Loyalty Platform
Auth bearer

Request Body

Business Object basket
Description Commerce container holding intended purchases before order creation.
Classification aggregate-root
Lifecycle open → locked → converted → abandoned → merged

Response

Business Object loyalty-account
Description Account used to track loyalty participation state, balances, benefits, and point activity.

Events Emitted

Event Classification Object Description
loyalty-points-redeemed transitioned loyalty-account Points were redeemed by the customer against a transaction.

Integration Patterns

Pattern Flow Style Description
POS → Loyalty Platform Earn/Redeem posloyalty-platform synchronous-api At transaction close, the POS triggers loyalty point accrual and handles redemption requests. Both operations are synchronous for immediate receipt display.

Scenarios using loyalty

Scenario Description
Clienteling Sale A store associate uses a clienteling application to identify a known customer, review their purchase
Customer Registration A new customer creates a unified identity that can be recognised consistently across digital and phy
Loyalty Enrollment A customer is enrolled into the retailer's loyalty programme during or after a transaction — in-stor
Loyalty Tier Upgrade A customer's loyalty standing is reviewed after new qualifying activity and may be promoted to a hig
Scan and Go Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in
API Method Path Type
Enroll Loyalty Member POST /loyalty/members command
Issue Loyalty Points POST /loyalty/accounts/{id}/points command
Earn Points POST /members/{id}/earn command
Get Member Balance GET /members/{id}/balance query