Pass Template Builder Settings for a Coupon

Appearance

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

Coupon Pass Template Builder Appearance Tab

FieldDescription
Offer Title Image/LogoUpload the offer title image or logo that will appear on the customer’s mobile wallet coupon. 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.
Card IssuerThe name of the company/organization issuing coupons. The card issuer 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 card issuer name exceeds 20 characters. This field is required to generate coupons.
Strip ImageThe 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.
BackgroundSet 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. 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’. This field is required to generate coupons.

Coupon Pass Template Builder Main Fields Tab

Additional Fields

These fields will appear on the back of the Pass on Apple Wallet and below the Pass on Google Pay.

Coupon Pass Template Builder Additional Fields Tab

Coupon Pass Template Builder Additional Fields Tab 2

Coupon Pass Template Builder Additional Fields Tab 3

FieldDescription
Pass ExpirationCheck the box if the Pass should have an expiration date. Choose a date and time for the Pass to expire.
Field 1: Expiry DateThis is a fixed field that takes the expiration date set in ‘Pass Expiration”.
Field 2: Offer DetailsAdd 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/TermsAdd the fine print or terms for the offer/coupon. This field allows line breaks. The label is a fixed value.
Field 4: Offer ProviderThe company providing the offer or coupon. The label is a fixed value. This field is required to generate coupons.
Field 5, 6 & 7: Message 1, Message 2 & Message 3These 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 8: Text ModuleThe 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 9: Info ModuleThe 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 10: Home Page URIAdd a link to the merchant’s website.
Field 11: Help URIAdd a link to support or help information on the merchant’s website.
Field 12 & 13: Link 1 & 2Add 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

Coupon Pass Template Builder Barcode Fields Tab

FieldDescription
Barcode TypeSelect the type of barcode you want to use on the Pass. Supported types include: QR Code, Code 128, Aztec, and PDF 417
Default Barcode ValueSelect the default barcode value that will appear if no value is passed in the API or if you have not selected ‘autogenerate barcode’
Autogenerate BarcodeCheck this box if you want to generate a random barcode value for your Passes.
Autogenerate ValueSelect the data type and data length (10-100 characters) of barcode you would like to autogenerate:

  1. Numeric Only
  2. Alphabet Only
  3. Alphanumeric
Preview BarcodeEnter 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.

Coupon Pass Template Builder Apple Wallet Fields Tab

FieldDescription
Text ColorAdd any color to the text fields on Apple Passes only.
IconAdd an icon that will appear on your customer’s lock screen for Pass updates and notifications.
DescriptionAdd a description for blind and low vision users on Apple Passes.
Link to AppLink 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 TextAdd 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.

Google Pay Fields

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

Coupon Pass Template Builder Google Pay Fields Tab

FieldDescription
Disable Expiry NotificationsCheck 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 ChannelChoose how customers can redeem their coupons; in-store, online, both, or a temporary price reduction.
Additional ImageIf 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 DescriptionAdd a description for the additional image. The description will not appear on the Pass.

Relevance

Coupon Pass Template Builder Relevance Tab

FieldDescription
Relevant AddressAdd up to 10 GPS locations to display a message/notification on your customer’s lock screen when they are nearby.
Relevant Text for IOSThis is the custom text that will appear when the device is within the boundaries of the relevant address.
Relevant Text for AndroidThis 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

Coupon Pass Template Builder Advanced Tab

FieldDescription
Pass GenerationSelect whether you want to ‘Generate only personalized Passes’ or ‘Generate unique Passes upon any request’. Generating only personalized Passes requires you to import personalized data or call our API. Generating unique Passes upon any request will generate passes for every valid request.
Disable SharingSelecting 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.
Data Archive SettingsThese 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.

in Mobile Wallet