Skip to main content
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 the loyalty:read scope.

404 Not Found

No membership with that id in your company. A malformed id returns 404 as well, not 400.

502 Bad Gateway

The loyalty service is unreachable.

Operational notes

  • balance_points and stamps_count both exist regardless of program type. Only the one the program uses moves; the other stays at 0. Read the program’s type to know which to show.
  • serial_number is 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.
  • status is set in the portal, not here. A suspended or revoked membership 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 report balance_points: 0 while the ledger still shows a positive balance_after.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Path Parameters

id
string
required

Response

200 - application/json
membership
object
required