Loyalty API
TypeCustomerQRCodeResult1
The customer's member QR code payload and a customer-scoped, short-lived image URL rendering that exact payload.
| Kind | Type |
|---|---|
| Used in | CustomerQRCode1 |
The payload identifies one loyalty member. It is visible and copyable by design; possession of the payload is not proof of identity and does not authorize any account action.
Payload, image URL and wallet-pass download URL are three distinct outputs. A member QR image never downloads or updates a wallet pass, and a wallet pass may carry no QR code at all depending on shop configuration.
Properties
-
enabledboolean requiredFalse when the loyalty program is disabled for this customer.
When false,
payloadandimage_urlare omitted andexpires_atis null. Render a disabled or hidden QR section in this state. -
payloadstring required when enabled is trueThe exact text encoded in the member QR code.
The payload is a versioned identifier of this Bubblehouse member. The served image always encodes exactly this string.
-
image_urlstring required when enabled is trueA customer-scoped URL serving the QR code as a PNG image.
The URL carries a signed image-access token in its query string. It serves only this customer’s QR image and cannot authenticate API calls; it never contains a shop or admin API token, and the customer cannot be changed through any URL parameter.
-
When the token embedded in
image_urlstops being accepted.60 minutes after the response is generated. Request a fresh
CustomerQRCode1response to obtain a new URL after expiry.