Distributing wallet passes

Generating a link to a wallet pass

To let a customer add a published pass to their Apple Wallet or Google Wallet, generate a link to it in one of the following ways:

• In the wallet pass builder - see Generating a link manually below.
• With the walletpasslink/walletpasslinkvar Jinjava inserts - if you're sending the link from an email, SMS, or push campaign, generate a personalized link directly in the message template. See Wallet pass Jinjava inserts.
• By calling the API directly - request a link, optionally passing the customer's UUID, any parameters you want passed back in the walletPass.issued and walletPass.installed events, and an expiration date for the link. For the full request and response reference, see the API reference.

The returned link is permanent - you can embed it in customer communication or encode it as a QR code for the customer to scan. If you didn't provide a customer UUID when requesting the link, you can add one later by appending &clientUuid=<uuid> to the returned URL; the pass is then generated for that specific customer.

Anonymous vs. identified links

• If you generate the link without a customer UUID, it's a generic, anonymous link. When someone scans or opens it, Synerise creates a new anonymous profile for them, and all further events for that pass (walletPass.installed, walletPass.updated, and so on) are attached to that new profile.
• If you generate the link with a specific customer's UUID - for example, for a customer you've already recognized - the pass is generated in that customer's context, so any dynamic field driven by their profile data (such as a points or cashback balance) renders with their actual values.

Referencing profile data in a dynamic field, for example {{ customer.first_name }}, never fails - Synerise always has a profile to render the pass against, since it creates the anonymous profile before generating the pass. On an anonymous link, though, that profile is brand new and has no attributes or activity history yet, so such fields typically render empty. We recommend always wrapping such fields in an {% if %} check with a fallback value for when the attribute is empty, rather than relying only on a default filter. On an identified link, the same field resolves to that customer's real data.

Generating a link manually

From the wallet pass editor, you can generate a link to the wallet pass or its QR code (for example, to display it in a physical location so customers can scan it). You can also use this for testing the wallet pass.

1. In the editor, click Send to phone.
   Result: The pass generator view opens.
2. If you want to add a profile context (see "Anonymous vs. identified links"), click Profile context and select a profile.
3. If the fields in the wallet pass use the {{ context }} insert, add it to the link:
   1. Click Additional context.
      • To add with a builder:
        1. Click Add parameter.
        2. In Key (Name of the property), enter the key.
           This is the identifier used by the insert, for example {{ context.customerNickname }}.
        3. In Type & Default value, set the data type and value.
   • To enter the parameters as JSON:
     1. Click Raw JSON.
     2. In the text box, enter an object with the parameters.
   2. Click Apply.
4. If you want to add event parameters that will be added to events generated by this wallet pass:
   1. Click Event parameters.
      • To add with a builder:
        1. Click Add parameter.
        2. In Key (Name of the property), enter the key.
           The parameter will be saved in events under this key.
        3. In Type & Default value, set the data type and value.
   • To enter the parameters as JSON:
     1. Click Raw JSON.
     2. In the text box, enter an object with the parameters.
   2. Click Apply.
5. Copy the QR code or link.