Card Template Builder
Create Apple Wallet Passes or Google Pay Cards using our Card Template Builder. Passes or Cards are digital representations of plastic cards and tickets. Coupons, identification cards, boarding passes, and gift cards are a few forms a pass or a card can take. Below are the following settings used for the creation of a Pass or a Card within the Card Template Builder.
Provide the required Card Metadata.
|Status||The 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.|
|Category||There 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 Id||A 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 Name||The name used for external or display purposes on the public or client interfaces.|
|Internal/Technical Name||The internal name that will appear on the ’Pass Templates’ page.|
|Pass Key||The unique key which identifies the pass template. This is used when generating dynamic passes.|
|Organization||The name of the organization issuing the pass. This name will appear in push notifications.|
|Description||A brief description of your pass to be used by blind and low-vision users.|
Manage the card template’s barcode with the BARCODE tab.
|Import Options||This page provides instructions on importing dynamic pass data by API, CSV, and URL.|
|Add Barcode||Select whether or not to include a barcode in the pass template.|
|Barcode Type||Select the type of barcode to include in the pass template: QR Code, Aztec, PDF417, or code128.|
|Barcode Value||The 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 Text||The 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.
|Header||The 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.|
|Primary||In most cases there is only one primary field, but when the pass category ‘boarding pass’ is selected, there are two primary fields.|
|Secondary/Auxiliary||Store 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.|
|Label||Data 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.|
|Type||The 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 are located on the back of the digital pass or the card, and have the same layout regardless of the category. These text fields allow for more characters than the fields on the front of the pass or the card. 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.
When relevance is triggered, the pass or the card will appear in a notification on the phone’s lock screen with a customized message. The relevance of a pass or a card can be determined by time and/or location. The pass/card category selected will determine whether relevance is defined by time or location.
|Generic||Both relevant time and location can be set. If you choose to set relevance, location is required, and time is optional.|
|Boarding Pass||Both relevant time and location can be set.|
|Store Cards/Coupons||Only relevant location can be set.|
|Event Tickets||Both relevant time and location can be set. If you choose to set relevance, time is required and location is optional.|
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.
|UUID (Universally unique identifier)||A unique identifier is used to distinguish your beacon from other beacons.|
|Major||A number used to specify the Beacon within a group.|
|Minor||A number used to identify specific Beacons.|
|Relevant Text||The text that will be displayed in the notification.|
The Advanced tab allows you to set an expiration date of the card template. In addition, you can promote an app with a banner on the back of the pass. To do this, provide the link to an iOS and/or Android application. The platform supports both Apple Wallet and Google Pay.
Setup the following Issuance.
|Pass Generations||Two options are provided:
Generate only personalized passes
Generate unique passes upon any request
|Limit Total Passes||Limit the number of passes that can be generated.|
|Type of Issuance||There are two types of issuance:
|CustomerRef Settings||Set 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 Settings||Set 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 & Conditions||Terms and conditions will be shown before pass installation.|