Pass Template Builder Settings for a Loyalty Card (Layout 1) #
The Pass Template for the Loyalty Card layout 1 allows users to create a loyalty card template with a strip image and 2 fields on the front of the Pass.
Appearance
Customize the appearance for the loyalty card by adding strip images, logos, and background color.
| Field | Description |
|---|---|
| Card Issuer | The name of the company/organization issuing loyalty cards. The card issuer is displayed below the logo on Google Wallet passes and to the right of the logo on Apple Wallet Passes. An ellipsis will be displayed if the card issuer name exceeds 20 characters. The card issuer is required to generate loyalty cards. |
| 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. |
| Program Logo for Apple Wallet | Upload the rectangular Loyalty Program Logo that will appear on the customer’s loyalty card. The logo will appear square/rectangular in the top left corner of the Pass on Apple Wallet. It is recommended to leave the logo with a full bleed background color and a 15% margin. The logo is required to generate loyalty cards. |
| Program Logo for Google Wallet | Upload the circular Loyalty Program Logo that will appear on the customer’s loyalty card. The logo will appear rounded in the top center of the Pass on Google Wallet. The minimum size for the logo is 660px by 660px. It is recommended to leave the logo with a full bleed background color and a 15% margin. The logo is required to generate loyalty cards |
| Strip Image | The strip image is displayed as a banner across the center of the Pass for both Apple Wallet and Google Wallet. 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. |
Main Fields
These fields will appear on the front of the Pass for both Apple Wallet and Google Wallet.
| Field | Description |
|---|---|
| Field 1: Loyalty Points Label | The number of loyalty points, such as ‘Points’. Special characters are allowed for the label and value for this field. |
| Field 2: Program Name | The name of the Loyalty program. |
| Field 3: Secondary Loyalty Points | Add another loyalty points field, such as ‘Rewards’. Special characters are allowed for the label and value for this field. |
Expiration Fields
| 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 | Auto expire the pass by setting a fixed duration after which the pass gets expired automatically from the time of its first generation. If any specific expiration timestamp is set for the pass record, then these settings will be overridden by the pass record expiration timestamp. |
| No Expiration Date | Choose this option if you do not want to set an expiration date. |
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 |
|---|---|
| Field 1: Account Name | The name for the loyalty card account, such as ‘Member Name’. |
| Field 2: Account ID | The account or member ID number |
| Field 3: Rewards Tier | The rewards tier for the member/account holder. |
| Fields 4-6: Message 1-3 | These are optional fields to add longer messages (500-1,000 characters) on the back of the Pass for Apple Wallet or in the Pass Details section on Google Wallet. These fields allow line breaks. Messages 1-3 are static fields. Supports Link text anchor links (https only) as well. |
| Fields 7-13: Message 4-10 | These are optional fields to add longer messages (500-1,000 characters) on the back of the Pass for Apple Wallet or in the Pass Details section on Google Wallet. These fields allow line breaks. Messages 4-10 are dynamic, meaning they can be personalized for each user. Supports https://… anchor links (https only) as well. |
| Field 14: 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. |
| Field 15: Info Module | The recommended maximum length for the label is 30 characters to ensure the full string is displayed on smaller screens. The recommended maximum length for the value is 30 characters to ensure the full string is displayed on smaller screens. |
| Field 16: Home Page URI | Add a link to the card issuer’s website. |
| Field 17 & 18: 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. |
Transaction Fields
Use My Own Redemption System
| Field | Description |
|---|---|
| I don’t want a barcode | Choose this option to remove the barcode from the Pass Template. If this is selected, no barcode will appear on any Passes issued using this Template. |
| Redemption System | Choosing “Use My Own Redemption System” will require a third-party scanning app to scan Passes as well as an integration to update Pass Statuses to “Redeemed”. |
| Redemption Type | Redemption type will always be set to “Barcode”. Contact us if you need NFC support. |
| 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 may also choose “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. |
Use WalletThat’s Redemption System
| Field | Description |
|---|---|
| Redemption System | If you choose to use “WalletThat’s Redemption System”, the barcode value will automatically be replaced with a WalletThat redemption URL to enable employee-based redemption. |
| Redemption Type | QR code is required to use WalletThat’s Redemption URL system. |
| Redemption Profile | Choose a redemption profile to link to the Pass Template. If you haven’t created a profile yet, click “Create a New Redemption Profile.” You can use this guide to learn how to create a redemption profile: Creating a Redemption Profile |
Apple Wallet Fields
The fields listed in the ‘Apple Wallet Fields’ tab are only applicable to Apple Wallet Passes.
| Field | Description |
|---|---|
| Apple Pass Type Id | The Apple Pass Type ID assigned to this Pass Template. If you have multiple Pass Type IDs, you can select which one to associate with this template from the dropdown menu. |
| 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. |
| Install Page Background Color | Set the background color for the pass installation pages. |
| “Downloading your pass…” message |
Custom rich-text shown as the “downloading your pass” message on the pass installation page. |
| “Thanks for downloading” message | Custom rich-text shown as the “thanks for downloading your pass” message on the pass installation page. |
| “If your pass does not download automatically…” text | Custom rich-text to display to the end user if their Pass fails to download. Write it in any language. Leave blank to use the default shown; use “Clear” to hide it entirely. |
| Display Logo on Pass Installation Pages | Choose whether or not you want to display the logo uploaded in the above field on the installation pages. |
| Display Checkmark on Pass Installation Pages | Choose whether or not you want to display a generic checkmark on the installation pages. |
| Preview Install Page | Click “Preview Install Page” to test your installation pages. |
Google Wallet Fields
The fields listed in the ‘Google Wallet Fields’ tab are only applicable to Google Wallet Passes.
| Field | Description |
|---|---|
| Google Issuer ID | The Google Issuer ID assigned to this Pass Template. If you have multiple Issuer IDs, you can select which one to associate with this template from the dropdown menu. |
| Additional Image Description | Add a description for the additional image. The description will not appear on the Pass. |
| Link to App | Enter the Google Play Store ID to link an app to the Google Wallet Pass. |
| Disable Screenshotting | Enable or disable screenshotting on Google Wallet Passes by checking this button. |
Relevance
| Field | Description |
|---|---|
| Relevant Address | Add up to 10 GPS locations to display a message/notification on your customer’s lock screen when they are nearby. |
| Relevant Text for Apple | 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. |
| Enable Update Notifications | When enabled, you can send a lock-screen “Last Notification” message to installed passes when you update them, and a “Last Notification” field is reserved on the back of the pass. Disable this if you never send update notifications — the field will not appear. Changing this setting will prompt you to push an update to existing passes. |
| 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. |