Guides

Create Templates

In this page you'll learn how to create a pass template. Pass templates are based on Apple's Wallet technology, if you wish to learn more about it, please read their guides here.

To access this page, expand the menu item Loyalty and click in Pass Designer:

Menu 178270cd18

Then click in the New Template button from the list of pass templates:

New template button d09b94e2e1

In that page you'll find the pass template wizard, which is divided in four different tabs like shown below:

Tabs b950c7ad71

Setup

In this tab you will need to provide a name for your template:

Name 419c67a7ff

Optionally you can provide an organization name. This text will be shown in the lock screen and notification center messages your passes might generate. If left blank we will use the organization name in the Pass Type ID certificate:

Organization edc05ad705

Optionally you can provide a description. This text will be shown as the title of your pass, if left blank we will use the app's name:

Description 1806764e8c

And you will have to select one of the pass styles available for you:

Style 3cc297b83b

To learn more about these styles please read our guides located here.

If you select the Boarding style, you will also need to provide the transit type you want to use:

Transit e9b5d84f1f

If you select the Ticket type, you can optionally define if it should have a thumbnail:

Thumbnail be791b71f1

Design

In this tab you will be uploading the artwork needed for your template as well as selecting the colours used in your pass. Depending on your pass style you will need to provide a certain number of images for your template:

Artwork dbb079bf0e

You will also need to provide the colours we should use for the template:

Colours 01e9211d1e

Please note that you should upload images that fill the allotted space available for each one of them. Sizes are presented in points so you will want to convert to pixels and optimize them for high density screens (usually 2 or 3 times bigger).

Fields

Optionally you can add fields to your pass. This is the only way you have to present data in your passes so in most cases and depending in the style you choose, you'll want to add them strategically.

If you wish to provide a text to be displayed next to your logo, use the following field:

Logo text b0d3f8a26c

Then you can add one or more fields for each type available: Header, Primary, Secondary, Auxiliary or Back fields. Once again, understanding pass styles is crucial before deciding what fields to create.

Each one of them will let you add a field from a selector like the one below:

Header fields da61a0e976

There are three types of fields, String, Date and Number. For all types you'll always have to provide a Key, this should have a unique value for each field you create:

Key ba63b93e46

Please note that each field's key should not use reserved names. Here's a complete list of reserved names:

  • relevant_date
  • expiration_date
  • voided
  • barcode_message
  • barcode_alt_text
  • barcode_show_alt_text
  • barcode_format
  • barcode_message_encoding
  • description
  • beacon_proximity_uuid
  • beacon_major
  • beacon_minor
  • beacon_relevant_text
  • location_latitude
  • location_longitude
  • location_altitude
  • location_relevant_text
  • location_region_id
  • location_region_major
  • message
  • title
  • subtitle
  • user_info
  • app_launch_url
  • associated_store_identifiers
  • max_distance
  • background_color
  • foreground_color
  • grouping_identifier
  • label_color
  • logo_text
  • suppress_strip_shine
  • nfc_message
  • nfc_encryption_public_key
  • transit_type
  • redeem_type
  • redeem_limit

You will also have to always provide the Label, which will be visible to the user:

Label 955aa7bede

And you should always provide the alignment of field, which can be Left, Right, Center, Natural:

Text alignment a90a82fa6d

Optionally every field will support a Modified Message, when provided it will generate a lock screen message whenever the value of the field changes. Use the placeholder %@ in your text to show the new value:

Modified message bba0a238a1

If you choose Date as your field type, you should also provide the Date Style and Time Style:

Date time styles c63f94909f

For Date fields you can also make sure the date displayed is shown in the device's timezone by ignoring the timezone included in its value. To do that toggle the following option:

Ignores timezone a153d0b33e

And finally, for Date fields you can also show a relative date instead of an absolute one. For that toggle the following option:

Relative date a48f797816

If you choose Number as your field type, you should also provide the Number Style, which can be Decimal, Percent, Scientific or Spell Out:

Number style d50f3f4f33

For the Number field type, if you using it to display a money value, you should instead provide the ISO 4217 currency code in the following field. Adding a Currency Code will hide the Number Style:

Currency code cff30411d5

Also note that the order of the fields in each list can be changed by simply dragging the following icon and dropping the field into the new position:

Drag icon 54110862d1

Barcode

In this area you will be specifying which kind of barcode you will want to use for your passes. Your choice will depend in the type of scanners your company will use to scan these passes. Select one of the available options in the following field:

Barcodes 99441c8fb5

You can choose between QR Code, PDF417, 1D (a.k.a. Code128) or Aztec. You should obtain information about your scanning capabilities before choosing the type of barcode to use in your passes.

You can also provide a text encoding for the value of the barcode. By default we will use iso-8859-1 but depending on your scanning infrastructure you can choose another encoding format:

Barcode encoding e1c1213237

Finally if you wish to show a human readable text of the barcode in your pass, check the following option:

Show human readable bef69e4fce

As you create your template, you can obtain a preview by clicking in the Preview button:

Preview button ddda310e4b

This will open a window like the one below, allowing to preview how you template will look like:

Preview modal d43f6377ed

And once you are ready to create your template, click in the Create Pass Template button:

Create button 15a4f2eda3

Keep reading our guides to learn how to edit a pass template.