Pass Template Builder

Create Apple Wallet Passes using our Pass Template Builder. Apple Wallet is a mobile wallet app developed by Apple®. The wallet stores .pkpass files, commonly referred to as Passes. Passes are digital representations of plastic cards and tickets. Coupons, identification cards, boarding passes, and gift cards are a few forms a pass can take. Below are the following settings used for the creation of a Pass within the Pass Template Builder.

General

Provide the required Pass Metadata.

Pass template builder

SettingDescription
StatusThe life cycle status of the pass. The default status is ‘Draft’ when creating new passes. Only pass templates with the ‘Approved’ status can be set to ‘Public’ publish status. Once the pass is public, the status cannot be changed to ‘Draft’ status.
CategoryThere are five pass categories: Generic, Boarding Pass, Coupon, Event Ticket, and Store Card. The category selected will determine the layout of the final pass. Once saved the category of a pass template cannot be edited. Examples of each pass category can be previewed on the platform for your reference.
Template IdA unique identifier that is used to identify this pass template. This ID is used in the API to add pass data to the pass or generate dynamic passes.
External/Template NameThe name used for external or display purposes on the public or client interfaces.
Internal/Technical NameThe internal name that will appear on the ’Pass Templates’ page.
Pass KeyThe unique key which identifies the pass template. This is used when generating dynamic passes.
OrganizationThe name of the organization issuing the pass. This name will appear in push notifications.
DescriptionA brief description of your pass to be used by blind and low-vision users.

Data Settings

Manage the pass template’s barcode with the data settings tab.

data settings

SettingDescription
Import OptionsThis page provides instructions on importing dynamic pass data by API, CSV, and URL.
Add BarcodeSelect whether or not to include a barcode in the pass template.
Barcode TypeSelect the type of barcode to include in the pass template: QR Code, Aztec, PDF417, or code128.
Barcode ValueThe value provided by the barcode when scanned. Set your barcode value to fixed or dynamic. If the pass template includes a barcode, a barcode value must be assigned. The barcode value can be set as editable. Help text can be added to display more information about the barcode value field to users.
Alternate TextThe text that is displayed beneath the barcode. This can be set as fixed, dynamic, or the same as the barcode value.

Header, Primary, Secondary & Auxiliary Fields

The header tab, primary tab, secondary tab, and auxiliary tab are all text fields that appear on the front of the pass. They all behave similarly with a few notable differences.

field text passes

SettingDescription
HeaderThe header text will always appear in the top right hand corner of the pass. Depending on the length of the header text, and the size of the logo image, the header text may overlap the logo image.
PrimaryIn most cases there is only one primary field, but when the pass category ‘boarding pass’ is selected, there are two primary fields.
Secondary/AuxiliaryStore Card and Coupons allow up to two secondary and two auxiliary fields, while the remaining pass categories allow up to four secondary and four auxiliary fields.
SettingDescription
LabelData in label field can be static where the text is the same for all users, or dynamic where the text can differ depending on the user. Apple devices will display the label text in all capital letters. The color of the label text is determined by the ‘field label’ color in the appearance tab. Label can be set as editable.
TypeThe type of text that will be used to populate the value field. The four type options are: text, date & time, number, and currency. Additional settings may be required once a type is selected. The value type ‘text’ is the only type where dynamic data can be inserted.
Value (Text)Data in the value field can be static where the text is the same for all users, or dynamic where the text can differ depending on the user. The color of the value text is determined by the ‘field value’ color in the appearance tab. The value can be set as editable. Help text can be added to display more information about the value field to users.

Back Fields

Back fields are located on the back of the digital pass, and have the same layout regardless of the pass category. These text fields allow for more characters than the fields on the front of the pass. Links, phone numbers, addresses, and email addresses will all be clickable when entered into the back field values. You are allotted up to four back fields. Data can be set as dynamic or static.

Pass Template Builder

Relevance

When relevance is triggered, the pass will appear in a notification on the phone’s lock screen with a customized message. The relevance of a pass can be determined by time and/or location. The pass category selected will determine whether relevance is defined by time or location.

Relevance

SettingDescription
GenericBoth relevant time and location can be set. If you choose to set relevance, location is required, and time is optional.
Boarding PassBoth relevant time and location can be set.
Store Cards/CouponsOnly relevant location can be set.
Event TicketsBoth relevant time and location can be set. If you choose to set relevance, time is required and location is optional.

pass notifications

iBeacons

Similar to the relevance tab, iBeacons display notifications on devices. While Relevance displays a notification based on a time and/or geographical location, iBeacons do so based on the location of a Beacon. A Beacon is a Bluetooth enabled device that serves as the physical midpoint of a region. When other Bluetooth enabled devices (i.e. user’s phones) that are connected to the Beacon are within the set region, they will have the ability to receive data transmitted from the Beacon. Devices such as an iPad can serve as a Beacon.

iBeacons display notifications

SettingDescription
UUID (Universally unique identifier)A unique identifier is used to distinguish your beacon from other beacons.
MajorA number used to specify the Beacon within a group.
MinorA number used to identify specific Beacons.
Relevant TextThe text that will be displayed in the notification.

Advanced

Similar to the relevance tab, iBeacons display notifications on devices. While Relevance displays a notification based on a time and/or geographical location, iBeacons do so based on the location of a Beacon. A Beacon is a Bluetooth enabled device that serves as the physical midpoint of a region. When other Bluetooth enabled devices (i.e. user’s phones) that are connected to the Beacon are within the set region, they will have the ability to receive data transmitted from the Beacon. Devices such as an iPad can serve as a Beacon.

advanced passes

back of pass preview

Preferences

Setup the following preferences.

pass preferences

SettingDescription
Pass GenerationsTwo options are provided:

Generate only personalized passes
This setting will require that every pass is created through an API or a CSV. Each pass must include a customer reference, such as a phone number or email, to ensure that it is created for the personalized use of a single user.

Generate unique passes upon any request
This setting will allow passes to be created outside of an API or a CSV. In addition, those created in an API or a CSV would not require a customer reference, though it will still be accepted. If this setting is turned on, then the “Allow (1) Pass Per Request” setting will be available. This setting prevents a single user from requesting multiple passes by limiting them to a single request via customer reference, such as a phone number or email. When a second request is triggered, the original pass will be resent.

Limit Total PassesLimit the number of passes that can be generated.
Type of IssuanceThere are two types of issuance:

Self Issued
The users provision the data themselves and generate the card.

Organization Issued
The organization provisions the data. If ‘Self Provisioned’ is selected, then the users create the card by providing some reference/secret pin that references the card. Customer reference and authorization settings are included. If ‘Organization Provisioned’ is selected, then the organization creates the card and distributes it to the users.

CustomerRef SettingsSet customer reference authorization for distributing passes to a particular end user. Check the ‘Turn ON Customer ref setting’ checkbox to turn on customer reference authorization. Note that you must provide a secret question if authorization is turned on. You can include help text to the secret question to provide a hint on how to answer it. Answer types can be alphanumeric, numeric, or date. An example of a secret question could be a request for the customer’s phone number, email address, personal ID number, etc.
Authorization SettingsSet general authorization for distributing passes to a particular end user. Check the ‘Turn ON Authorization’ checkbox to turn on authorization. Up to two secret questions are allowed. Note that you must provide a secret question if authorization is turned on. You can include help text to the secret questions to provide a hint on how to answer them. Answer types can be alphanumeric, numeric, or date. An example of a secret question could be a request for a secret password, passcode, etc.
Terms & ConditionsTerms and conditions will be shown before pass installation.

in Mobile Wallet