Page summary
- 1. Enable the Wallet option in the Administration module:
- 2. Create an API for external wallets
- 3. Verify the functionality
- 4. Supported Fields in Wallet Passes
- Fields Included in Both Google and Apple Wallet Passes
- Fields Included Only in Google Wallet Passes
- Conditional Fields (Only Included If Available)
- Both Google and Apple Wallet
- Only Google Wallet
- 5. Important Notes
- 6. Wallet Versions Supported
Google Wallet and Apple Wallet Feature
This article explains how to activate the Google Wallet and Apple Wallet options in confirmation emails. This feature allows passengers to add purchased tickets to their digital wallets for easy access on their devices.
1. Enable the Wallet option in the Administration module:
- Go to Administration > Setup
- Scroll down until you find the option:
Confirmation email for Reservations includes links to external wallet applications (Google Wallet, Apple Wallet)
- Select this option and click Save.
2. Create an API for external wallets
To ensure the wallet functionality works correctly, you need to create an API called "external-wallets". For doing so, follow these steps:
- Navigate to Administration > Integrations > applications.
- On the right top corner, select the "Add new" option.
- Name the API "external-wallets" and complete the setup.
3. Verify the functionality
Once all the steps have been completed correctly, every confirmation email will include the option for passengers to add their tickets to Google Wallet or Apple Wallet, as shown below.
4. Supported Fields in Wallet Passes
Fields Included in Both Google and Apple Wallet Passes
- Passenger first and last name
- Purchase (Transaction) ID
- Ticket number
- QR code for scanning (value is
accountID-ticketID
) - Departure date and time
- Arrival date and time
- Departure station name
- Arrival station name
- Terms and Conditions link
Fields Included Only in Google Wallet Passes
- Purchase date and time (when the transaction was fully paid)
- Ticket cost
Conditional Fields (Only Included If Available)
Both Google and Apple Wallet
- Operating company name (if the ticket has
operatingCompanyId
andoperatingCompanyName
) - Section, row, and seat (if the ticket has a seat assigned in the seatmap)
- Departure station geo-coordinates (if available)
- Arrival station geo-coordinates (if available)
Only Google Wallet
- Ticket fare name (if available)
- Ticket fare class name (if available)
5. Important Notes
- This option only works for RESERVATIONS type of products.
- If you encounter any issues enabling this feature, please contact our support team for assistance.
6. Wallet Versions Supported
- iOS: iOS 11 or higher
- Android: Android 9.0 or higher