Apple Wallet: When the user clicks a pass link, the device’s default browser will open the link and render the pass, and the user may then save the pass to the device's Wallet app.
Google Pay: When the user clicks the pass link, the device’s Google Pay app will open the link, and the user may then save the pass.
No setup is required. You can distribute a pass link to users as soon as you create it. Just include the link in the body of your message.
Caveats for Google Pay and Apple Wallet pass links are noted below. You can also distribute an Adaptive LinkA mobile wallet pass link that supports templates for both Google Pay and Apple Wallet. When a user taps the link, Airship determines the user's platform and generates the right pass for the user. instead.
- Apple Wallet pass links must be publicly accessible. See:
- Airship hosts the pass for your convenience, but if your use case requires you to download and host the file yourself, you can.
- Make sure the server hosting the pass has the MIME-type correctly set for .pkpass files.
- For Mobile Safari to recognize the file, your server has to be properly configured to support the MIME-type
application/vnd.apple.pkpass. The process for adding MIME-type support varies by web server vendor. Many hosting companies provide a control panel interface which allows you to easily add a new type.
Single- vs Multi-Use Public URL
When generating a pass via the
API, you can
create a publicly accessible URL for the pass, hosted at
https://wallet-api.urbanairship.com. The Public URL can be either a single
or multiple (multi-use) pass type, referring to the number of times the pass
can be be downloaded.
Use the Single option if you are creating a unique pass. A Single Public URL can only be downloaded once, but the user can share the pass from the Apple Wallet directly.
Use the Multiple option if the pass is non-unique and can be downloaded by multiple devices and shared many times.
A public URL is required for Android and optional for iOS.
The URLs returned by the CSV Batch Importer are multi-use passes — they can be downloaded by multiple devices.
Apple vs Google URL Differences
From the user’s perspective, the pass installation experience is similar on either iOS or Android — the pass is ultimately downloaded directly to either the Apple Wallet or Google Pay app. However, there are differences between the pass URLs:
Apple Wallet: Pass URLs generated from Apple Wallet templates point to a stored .pkpass file. A .pkpass file can be considered similar to a PDF or any other document that you might link to.
Google Pay: Pass URLs generated from Google Pay templates provide a deep link from Google into the Google Pay app so that the pass can be downloaded directly without requiring a browser window to facilitate the request.
For additional detail about the
publicUrl object and pass deep linking, see: