Loyalty API
TypeWalletPassStatus1
Wallet-pass availability for the customer, including a customer-scoped download URL when passes are enabled.
| Kind | Type |
|---|---|
| Used in | CustomerBalance3, ListCustomers3, LoggedOutBalance1 |
Generating this status never issues, downloads or updates a wallet pass. The pass is created or updated only when the customer actually opens the download URL.
Properties
-
apple_enabledboolean requiredWhether Apple Wallet passes are enabled for this shop.
When false, no download URL is returned. Render a disabled or hidden wallet-pass section in this state.
-
apple_download_urlstring required when apple_enabled is trueA customer-scoped URL that downloads (adding if necessary) this customer's Apple Wallet pass.
The URL carries a signed pass-download token in its query string. It permits only this customer’s Apple Wallet download and cannot authenticate API calls; it never contains a shop or admin API token.
The embedded token expires 60 minutes after the response is generated. Request a fresh
CustomerBalance3response to obtain a new URL after expiry.The URL is rejected when Bubblehouse has not stored the customer yet, or when the loyalty program is disabled for the customer.
Opening the URL records the pass download and can award points configured for wallet-pass downloads, so only open it on a deliberate customer action such as tapping an Add to Wallet button.