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 create a pass, click in the New Pass button from the list of passes:

Loyalty passes new button eade3a6345

In that page you'll find the pass wizard, which is divided in five different tabs. Start by selecting the Setup tab:

Loyalty templates tab setup a8afe8571a

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:

Loyalty passes search template a8349982cc

Once you've found the template you want to use, select it to proceed to the other tabs:

Loyalty passes selected template eadc17469a

Redeem

In this tab you will be determining how your pass can be redeemed or when it will expire. Click in the following tab to reveal all the options:

Loyalty templates tab redeem 01ed4e815d

Start by selecting between Always, Once or N Times in the redeem options selector:

Loyalty passes create redeem a38ba4f3ba

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

Loyalty passes create redeem times e12dadfbca

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

Loyalty passes create expiration date 7d94213146

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. Click in the tab Relevance to reveal all the options:

Loyalty passes tab relevance 94b3452cde

If you wish to prompt the pass in the lock screen when user is near one or more locations, you search for any address or any of the geo-zones, POI's, cities or countries you've created. To search for any address:

Loyalty passes relevance search address e386c4c4f8

For a previously created geo-zone:

Loyalty passes relevance search geo zone 6323b4f2fa

For a previously created POI:

Loyalty passes relevance search poi 7daf7c5fa4

For a previously created city:

Loyalty passes relevance search city ad7e97ca27

Or for a previously created country:

Loyalty passes relevance search country 5d239ca4b3

As you add locations, they will be listed as follows:

Loyalty passes relevance selected location ee6acaf83c

For each location you can also provide the text which will be shown in the lock screen:

Loyalty passes relevance relevant text ce81b445bc

If you add locations you can also specify a maximum radius where those location 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:

Loyalty passes relevance max distance 59bf45e09c

Additionally if you using iBeacons, you can also use them as the lock screen trigger for your passes. Click in the checkbox below to include BTLE devices:

Loyalty passes relevance beacons 6621426c06

Then to add beacons, click in the Add a beacon? link, to add an entry to that list:

Loyalty passes relevance beacon entry 8dc6e2636e

By default we will add an entry using only the Proximity UUID for your app, but you can also be specific and include the major:

Loyalty passes relevance beacons major fe4ad7620e

And include the minor:

Loyalty passes relevance beacons minor 0c9a87397b

For each beacon you can also provide the text which will be shown in the lock screen:

Loyalty passes relevance relevant text ce81b445bc

To add more beacon you simply need to click in the Add another beacon link:

Loyalty passes relevance add another beacon 337cf03930

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

Fields

Optionally the template you choose might contain fields. Click in the tab Fields to reveal which fields you should provide values for:

Loyalty passes tab fields d551c9d32d

Depending on the fields added to the template used to generate this pass, you'll see the following options. If a field is of type String you'll have to fill a text in a field the one below:

Loyalty passes fields string 8af8a043dc

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

Loyalty passes fields date 2f2ac22da3

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

Loyalty passes fields number 48008510c4

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:

Loyalty passes fields user info 5bc8e3ba79

This data can be used to pass information about the user that an app can make sense of. For example in a member card this object can 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:

Loyalty passes tab barcode 907c61357a

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:

Loyalty passes barcode custom 688665399e

As you create your pass, you can see a preview of what it will look like, by clicking in the Preview button:

Loyalty templates preview button c746a8bab1

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

Loyalty templates create button 24adaa0889

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