Skip to content

Get Member Balance

GET /members/{id}/balance query bearer

Returns current points balance, tier status, and next tier threshold for a loyalty member.


Overview

ID get-member-balance-api
Method GET
Path /members/{id}/balance
Classification query
Domain loyalty
Capability loyalty
Service calculate-points
Application loyalty-platform — Loyalty Platform
Auth bearer

Response

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

Integration Patterns

Pattern Flow Style Description
eCommerce Platform → Loyalty Platform Balance ecommerce-platformloyalty-platform synchronous-api At checkout start, the eCommerce Platform retrieves the customer's current points balance so the customer can choose to redeem during payment.

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
Redeem Loyalty Points POST /loyalty/accounts/{id}/redemptions command
Earn Points POST /members/{id}/earn command
Redeem Points POST /members/{id}/redeem command