Guides

Create Passes

In this page you'll learn how to create a pass. Passes are generated based on a previously created pass template. If you did not create one yet, please read the guides located here.

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

menu

To create a pass, click in the New Pass button from the list of passes:

new pass button

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

tabs

Setup

In this tab you will need to select which template you'll use, depending on the template you use other tabs require different input. You start by searching for an existing template:

search templates

Once you've found the template you want to use, click on it and it will look like this:

selected template

Soon you select a template you will be able to change the Organization Name assigned to it (if any):

organization

You will also be able to change the Description initially assigned by your template:

description

Redeem

In this tab you will be determining how your pass can be redeemed or when it will expire. Start by selecting between in the Redeem Options selector:

redeem options

If you select Redeem Pass N Times you will need to also provide the number of times the pass can be redeemed:

redeem limit

Optionally, you can also provide a date where the pass will automatically expire, independently of the redeem options:

expiration date

Relevance

In this tab you can optionally provide information that will be trigger the pass to be shown in the lock screen based on location or time. If you wish to prompt the pass in the lock screen when user is near one or more locations (up to 10), you search for any address or any of the geo-zones, POI's, cities or countries you've created in the field below:

pick locations

Simply search for any of the options available like shown below:

search locations

As you click in the locations you want to add, they will be displayed like the following:

selected location

For each location you add, you can also define which text should show in the lock-screen whenever a user is in the vicinity. This is done by inserting a value in the following field:

relevant text

If you add locations, you can also specify a maximum distance within which those locations will be relevant. By default we will use 500 meters as we consider this a reasonable value but you can choose to change that value:

max distance

Additionally if have BTLE beacons, you can also use them as a relevant lock-screen trigger for your passes. Toggle in the option below to include beacons (up to 10):

use beacons

Then to add beacons, click in the Add a beacon? link from the following section:

beacons empty

By default we will add an entry using only the Proximity UUID for your app, like shown below:

beacon entry

If you want, you can also add a Major and Minor to achieve fine-grained precision for these lock-screen messages. For each beacon, pretty much like locations, you can also provide the text that will be shown in the lock-screen:

relevant text

Please note that only passes added to the user wallet, will be prompted in the lock screen based on this data.

Design

In this tab you will be able to change the look and feel of your pass. These settings are already configured by the template you use but you will be able to change for each individual pass. The artwork used by your pass will depend on the type of pass:

artwork

Finally, you can also change the colours used by your pass:

colours

Fields

Optionally the template you choose might contain fields. Depending on the fields added to the template, you'll see different field types. It is mandatory that all fields have values. If a field is of type String you'll have to fill a text in a field the one below:

string field

If the field is of type Date, you'll see a date picker like the one below:

date field

And if the field is of type Number you'll see a number input field like the one below:

number field

And if the field is of type Number with a currency, you'll see an input field like the one below:

field currency

Optionally if you wish to add a machine-readable object that a companion app can access (this data will not be visible for the user) you can include a JSON object in the following field:

user info

This data can be used to include information that an app can make sense of. For example in a member card this object could contain the preferences of the user to help staff know what a customer usually likes.

Barcode

Click in the Barcode tab if you wish to include a custom barcode value. By default we will generate a serial number for you but if you wish to include a value that your scanning infrastructure understands, you can provide one in the field below:

barcode

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

create button

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