Skip to navigation
Wallet

Mint a wallet pass install link

View as Markdown

Mints a SINGLE-USE link that installs the customer’s loyalty pass in Apple Wallet (os: ios) or Google Wallet (os: android). Hand the URL to the customer right away — QR code, SMS, email, or an in-app button; it is consumed by the first download. Re-minting is harmless: each link is single-use and a new mint invalidates nothing. Without an Idempotency-Key every call returns a fresh link; with one, retries replay the stored link.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerIdstringRequired

Perkss customer id (UUID) — the id returned by customer create/list.

Headers

Idempotency-KeystringOptional

Optional but recommended. When present, a retry with the same key and payload replays the stored response for 24h instead of re-executing; the same key with a different payload is rejected with 409 IDEMPOTENCY.PAYLOAD_MISMATCH.

Request

This endpoint expects an object.
osenumRequired

Target wallet platform: ‘ios’ (Apple Wallet) or ‘android’ (Google Wallet).

Allowed values:

Response

downloadUrlstring

Fully-qualified single-use install link — hand it to the customer (QR, SMS, email, in-app). Consumed by the first download.

passIdstring
The customer's loyalty pass id.
expiresenum

Link lifetime — every minted link is single-use.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
503
Service Unavailable Error