Pass Template Builder Settings for a Generic Pass #
The Pass Template for a Generic Pass allows users to create a generic pass template.
Appearance
Customize the appearance for the generic Pass by adding logos, a background color, and a card title.
| Field | Description |
|---|---|
| Background Color |
Set a background color for the Pass. The format is #rrggbb, where rrggbb is a hex RGB triplet, such as #ffcc00. The background color is the same for every Pass installed using this template. |
| Rectangular Logo for Apple Wallet | Upload the Apple Wallet logo that will appear on the customer’s generic Pass. The logo will appear square/rectangular in the top left corner of the Pass on Apple Wallet. The recommended sizes are 160px by 50 px, 320px by 100px or 480px by 150px. It is recommended to leave the logo with a full bleed background color and a 15% margin. The logo is not required. |
| Circular Logo for Google Wallet |
Upload the Google Wallet logo that will appear on the customer’s generic Pass. The logo will appear rounded in the top left corner of the Pass on Google Wallet. The minimum size is 660px by 660px and the maximum size is 840px by 840px. It is recommended to leave the logo with a full bleed background color and a 15% margin. The logo is not required. |
| Card Title |
Add a card title which will be displayed on the top of the generic Pass to the right of the logo. The card title is typically the name of the company/organization issuing the Pass. An ellipsis will be displayed if the card issuer name exceeds 15 characters. The card issuer is required to generate generic Passes. |
Universal Fields
Main Fields
These fields will appear on the front of the Pass for both Apple Wallet and Google Wallet.
| Field | Description |
|---|---|
| Main Field 1: Subheader/Header | The subheader and header fields are displayed below the logo on both Apple Wallet and Google Wallet generic passes. The subheader is the label for the header field. The header value is a dynamic field, therefore, it can be set in the template of personalized for each user. |
| Main Field 2-5: Custom Fields 1-4 | Add up to 4 custom fields on the pass. The first two custom fields appear in a row below the subheader/header and the last two custom fields appear below custom fields 1 & 2 in a row. |
| Field | Description |
|---|---|
| Set default expiration date time | (Optional) Add an expiration date for all Passes that are installed for this Template. The timezone will be used as default, if not sent in the request when generating/updating passes via API. |
| Expire passes automatically after fixed duration | Automatically expire passes by setting a fixed duration after which the pass gets expired automatically from the time of its first generation/installation. If any specific expiration timestamp is set for the pass record, then these settings will be overridden by the pass record expiration timestamp. |
Additional Fields
These fields will appear on the back of the Pass on Apple Wallet and in the Pass Details section on Google Wallet.
| Field | Description |
|---|---|
| Message 1, Message 2 & Message 3 | These are optional fields to add messages on the back of the Pass for Apple Wallet or in the Pass Details section below the Pass for Google Wallet. These fields allow line breaks and links. |
| Text Module | The recommended maximum length for the label is 35 characters to ensure the full string is displayed on smaller screens. The value of the Text Module is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure the full string is displayed on smaller screens. This field also allows line breaks. |
| Link 1 & 2 | Add any link including a link to a telephone number, URL, email address, or specific location. Google Wallet uses special icons to distinguish different types of URI’s for the fields that use links. To use an icon, select from the drop-down menu and enter the correct data. |
Barcode Fields
| Field | Description |
|---|---|
| Barcode Type | Select the type of barcode you want to use on the Pass. Supported types include: QR Code, Code 128, Aztec, and PDF 417. You can remove the barcode by selecting: No barcode. |
| Default Barcode Value | Select the default barcode value that will appear if no value is passed in the API or if you have not selected ‘autogenerate barcode’ |
| Autogenerate Barcode | Check this box if you want to generate a random barcode value for your Passes. |
| Autogenerate Value | Select the data type and data length (10-100 characters) of barcode you would like to autogenerate:Numeric OnlyAlphabet OnlyAlphanumeric |
| Preview Barcode | Enter text in this box to preview how the barcode will be displayed on the actual Pass. |
Apple Wallet Fields
The fields listed in the ‘Apple Wallet Fields’ tab are only applicable to Apple Wallet Passes.
| Field | Description |
|---|---|
| Text Color | Add any color to the text fields on Apple Passes only. |
| Icon | Add an icon that will appear on your customer’s lock screen for Pass updates and notifications. |
| Description | Add a description for blind and low vision users on Apple Passes. |
| Link to App | Link an app to the Pass. The app will only appear on the back of Apple Wallet Passes |
| iBeacons – UUID, Major, and Minor Values, and Relevant Text | Add up to 10 iBeacons for each Pass. Defining the UUID, Major, and Minor values are necessary for the iBeacon to work. Add relevant text that will appear on the customer’s screen when the iBeacon is detected in a range. |
| Pass Installation Background Messaging | Add custom wait and thank you messages that will appear on the user’s screen while downloading the Apple Wallet Pass from the install link and after they’ve installed the Pass. |
Google Wallet Fields
The fields listed in the ‘Google Wallet Fields’ tab are only applicable to Google Wallet Passes.
| Field | Description |
|---|---|
| Strip Image | The strip image is displayed as a banner below the barcode for Google Wallet Generic Pass Only. The required image type is a PNG file. The recommended image size is 1032px by 336px. Use an image with a colored background for the best results. |
| Additional Image | If you choose to upload an additional image for Google Wallet Passes, the image will appear below the Pass. The image will not appear anywhere on Apple Wallet Passes. |
| Additional Image Description | Add a description for the additional image. The description will not appear on the Pass. |
Relevance
| Field | Description |
|---|---|
| Relevant Lat/Long | Add up to 10 GPS locations to display a message/notification on your customer’s lock screen when they are nearby. Add the latitude and longitude for each address. Relevant locations are only applicable for Apple Wallet Passes. |
| Relevant Text for Apple Wallet | This is the custom text that will appear when the device is within the boundaries of the relevant address. |
Advanced
| Field | Description |
|---|---|
| Disable Sharing | Selecting this option will disable your customers from sharing the Pass on Apple Wallet or share the Pass install link on both Apple Wallet and Google Wallet to another device. |
| Data Archive Settings | These settings allow you to set a TTL (time to live) for each Pass. TTL settings can be set per Pass Template so that the value set for the TTL will get updated for each Pass depending on the events that occur. |