Skip to main content
GET
Obtener un template de wallet
Returns a single wallet template. Use it to inspect a specific version — for example the one an already-issued pass was built from, which is not necessarily the published one.

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 template with that id in your company.

502 Bad Gateway

The loyalty service is unreachable.

Operational notes

  • slot places the field on the card: header, primary, secondary, auxiliary, or back. Apple and Google render the slots differently, and each platform caps how many fields it shows — a template with more fields than a platform supports is truncated by that platform, not rejected.
  • barcode.type of none means the card carries no code, which is worth knowing before you build a scanner flow around it.
  • The bindings resolved today are {{balancePoints}}, {{stampsCount}}, {{tier}}, and {{serialNumber}}. Other placeholder-looking text in a value is rendered literally.

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
template
object
required