Pass Template Builder Settings for a Coupon (Layout 1) #

Appearance

Customize the appearance for the coupon by adding strip images, logos, and background color.

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.
Offer Logo for Apple Wallet	Upload the rectangular Offer Logo that will appear on the customer’s coupon. 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.
Offer Logo for Google Wallet	Upload the circular Offer Logo that will appear on the customer’s coupon. 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.
Card Issuer	The name of the company/organization issuing coupons. 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.
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.

Universal Fields #

Main Fields

These fields will appear on the front of the Pass for both Apple Wallet and Google Wallet. There is only one main field on coupon Passes called ‘Offer Title’. The ‘Offer Title’ describes the title of the offer, such as ‘20% Off Sales Items’. We require you to fill out this field to generate coupons.

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 in the Pass Details section on Google Wallet.

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: Offer Details	Add details about the offer or instructions on how to redeem the coupon. This field allows line breaks. The label is a fixed value.
Field 3: Fine Print/Terms	Add the fine print or terms for the offer/coupon. This field allows line breaks. The label is a fixed value.
Field 4: Offer Provider	The company providing the offer or coupon. The label is a fixed value. This field is required to generate coupons.
Field 5-7: 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.
Field 8-14: 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.
Field 15: 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 16: 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 17: Home Page URI	Add a link to the merchant’s website.
Field 18: Help URI	Add a link to support or help information on the merchant’s website.
Field 19 & 20: 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 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.

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.
Wait Message	Add a custom waiting message that will appear on the user’s screen while downloading the Apple Pass.
Thank you Message	Add a custom thank you message that will appear on the user’s screen after they’ve installed the Pass.
Pass Install Help Text	Add instructions to display to the user to let them know what do if the Pass does not automatically download.
Language for Help Text	Choose the language that you want to display the static installation text in.

Google Wallet Fields #

The fields listed in the ‘Google Wallet Fields’ tab are only applicable to Google Wallet Passes.

Field	Description
Disable Expiry Notifications	Check the ‘Disable Expiry Notifications for Google Wallet Pass’ if you do not want customers to receive a reminder that their coupons are expiring soon. Expiry notifications are typically sent to the Android device 48 hours before the coupon is set to expire.
Redemption Channel	Choose how customers can redeem their coupons; in-store, online, both, or a temporary price reduction.
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. You can preview how the additional image will appear by clicking ‘G Pay Preview’.
Link to App	Enter the Google Play Store ID to link an app to the Google Wallet Pass.
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 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.
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.