Obtener una membresía
Memberships
GET /v1/loyalty/memberships/{id}
Get one membership with its balance, stamp count, tier, and wallet serial number.
GET
Obtener una membresía
Returns a single membership — the current state of one customer inside one program. This is the balance you show at the till.
Endpoint
Required scope
loyalty:read
Headers
Path parameters
Example request
Response
200 OK
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theloyalty:read scope.
404 Not Found
No membership with that id in your company. A malformed id returns404 as well, not 400.
502 Bad Gateway
The loyalty service is unreachable.Operational notes
balance_pointsandstamps_countboth exist regardless of program type. Only the one the program uses moves; the other stays at0. Read the program’stypeto know which to show.serial_numberis the wallet identity. It is what the pass is keyed by in Apple and Google, and what the card’s barcode encodes by default. Scanning a customer’s card gives you this value, and you can resolve it back through this endpoint’s list counterpart.statusis set in the portal, not here. Asuspendedorrevokedmembership still accepts ledger movements through the API — the status is a label your own flow should honour, not an enforced lock.- The point-expiry caveat applies. On a program with
expiration_days, this can reportbalance_points: 0while the ledger still shows a positivebalance_after.