Skip to main content
POST
Emitir el link de descarga del pase de Apple Wallet
Issues the Apple Wallet card for a membership and returns a public download link for the .pkpass file. Opening it on an iPhone triggers the native “Add to Apple Wallet” flow. This is the symmetric counterpart to the Google save link: a URL you can put in a QR code, a WhatsApp message, or a button, rather than a binary you have to host yourself.

Endpoint

Required scope

loyalty:write

Headers

Path parameters

No body.

Example request

Response

201 Created

400 Bad Request

The program has no published wallet template, or Apple Wallet credentials are not configured for this deployment — see the notes.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the loyalty:write scope.

404 Not Found

No membership with that id in your company.

502 Bad Gateway

The loyalty service is unreachable.

Operational notes

The download link is unauthenticated by design. It carries an opaque share token that resolves the pass on its own — anyone holding the URL can download that customer’s card. Send it to the customer directly and do not put it anywhere public or indexable.
  • A published wallet template is required, same as for Google. Without one the call fails with 400 no published wallet template for this program.
  • Apple Wallet needs signing credentials to be loaded. They are provisioned out of band, separately from Google’s. If they are absent, the call returns 400 explaining so — Google Wallet issuance can be working while Apple is not.
  • Calling twice reuses the existing pass. The link stays valid; reissue if the customer lost it.
  • The raw .pkpass binary is not exposed through the public API. This surface is JSON, and the download link covers the same use case — same reasoning as media download.
  • Once added, the card stays in sync. Ledger movements refresh the balance on the customer’s phone without another call.

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

201 - application/json
download_url
string
required

Link público de descarga del .pkpass. Sirve para QR, WhatsApp o copiar y pegar