POS Integration Service APIAPIV1LoyaltyBalance

Get customer points balance (proxy)

View as MarkdownOpen in Claude

Proxy to loyalty-service GET /v1/h2h/points-balance. Resolves the tenant’s loyalty credential from per-tenant configuration. Returns current balance plus the nearest upcoming expiry, if any.

Authentication

X-Api-Keystring
API Key authentication via header

Query parameters

customerUuidstringOptional

Response

OK
codeinteger
balanceinteger
messagestring
isSuccessboolean
numOfPointsWillExpireinteger
nearestExpiryDateTimeUTCdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error