Customize the appearance for the gift card by adding strip images, logos, and background color.
Field
Description
Merchant Logo
Upload the Merchant Logo that will appear on the customer’s gift card. The logo will appear rounded in the top center of the Pass on Google Pay and will appear square/rectangular in the top left corner of the Pass on Apple 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.
Merchant Name
The name of the merchant issuing gift cards. The merchant name is displayed below the logo on Google Pay passes and to the right of the logo on Apple Wallet Passes. An ellipsis will be displayed if the merchant name exceeds 20 characters.
Strip Image
The strip image is displayed as a banner across the center of the Pass for both Apple Wallet and Google Pay. 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.
Background
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.
Universal Fields
Main Fields
These fields will appear on the front of the Pass for both Apple Wallet and Google Pay.
Field
Description
Card Balance Label
This is a fixed label for Gift Cards and will always appear as ‘Gift Card’
Card Balance Value
The monetary value or balance of the Gift Card
Currency Code
Select the currency code for the monetary value of the gift card.
Gift Card Number
The gift card number. This number appears below the barcode on both Apple Wallet and Google Pay
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.
Additional Fields
These fields will appear on the back of the Pass on Apple Wallet and below the Pass on Google Pay.
Field
Description
Pass Expiration
Check the box if the Pass should have an expiration date. Choose a date and time for the Pass to expire.
Field 1: Expiry Date
This is a fixed field that takes the expiration date set in ‘Pass Expiration”.
Field 2: Card PIN
Set the label and value for the gift card PIN.
Field 3: Event Number
The event number field is optional and is used by some merchants for gift cards.
Field 4: Last Updated
This is a fixed field that will update whenever the Pass is updated.
Field 5 & 6: Message 1 & Message 2
These are optional fields to add messages on the back of the Pass for Apple Wallet or below the Pass for Google Pay. These fields allow line breaks.
Field 7: 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. The recommended maximum length is 500 characters to ensure the full string is displayed on smaller screens. This field also allows line breaks.
Field 8: 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 9: Home Page URI
Add a link to the merchant’s website.
Field 10 & 11: Link 1 & 2
Add any link including a link to a telephone number, URL, email address, or specific location. Google Pay 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
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
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 Pay Fields
The fields listed in the ‘Google Pay Fields’ tab are only applicable to Google Pay Passes.
Field
Description
Additional Image
If you choose to upload an additional image for Google Pay Passes, the image will appear below the Pass. The image will not appear anywhere on Apple Wallet Passes. You can preview how the additional image will appear by clicking ‘G Pay Preview’.
Additional Image Description
Add a description for the additional image. The description will not appear on the Pass.
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 IOS
This is the custom text that will appear when the device is within the boundaries of the relevant address.
Relevant Text for Android
This is the fixed text that will appear when the device is within the boundaries of the relevant address. The text is defined by Google Pay and cannot be customized.
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 Pay to another device.
Pass 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.
