Wallet

Antavo’s Wallet module offers a seamless method to enhance the loyalty program with offline interactions. Loyalty passes feature a barcode or QR code for identification. Customers can download these passes onto their mobile devices, use them to collect points, or redeem rewards at your offline stores and events.

Mobile passes serve various purposes within loyalty programs, functioning as customers’ membership cards, coupons, or tickets earned through program participation. To facilitate this, a POS system must be integrated, allowing sales associates to scan the barcode or QR code stored in the customer’s mobile app.

Apple Passes are stored in customers’ Apple Wallets, exclusive to iOS devices. However, Google Passes are compatible with both Android and iOS through Google Pay. You have the flexibility to offer customers either one type of pass or both.

Access the module configuration page by clicking the wallet icon in the sidebar. The page will open to the collection of passes you have already set up, showing the following information:

Creating a new pass

Pass setup starts with the Pass editor, allowing you to choose pass colors, relevant images, and enter text for mobile passes. Create an unlimited number of pass designs to save and use later on any pass type.

The intuitive WYSIWYG editor provides an instant preview of how modifications impact both Apple and Google Passes. Use the selector on the top of the page to switch between views and applicable settings.

• Click Create new pass on the sidebar to start building a new pass

Type selection

• Select the type of pass you want to create

  • Coupons: Passes can be used as rewards, offering customers delightful coupons for discounts when making a purchase in your physical stores. There are two ways to reward customers with discount coupons:

    • Claimable rewards
      Customers redeem coupon rewards by spending their points on the membership site.

    • Surprise and delight benefits
      Unlike claimable rewards, instant rewards are not visible on the membership site. Instead of redeeming points, customers receive benefits when they complete specific actions. You can set up a rule in Antavo’s Workflows editor with a Reward claim action node. Alternatively, you can use an Assign pass action node without a reward being assigned, but this only issues a static coupon, meaning the same coupon code is displayed for every customer’s pass. When using surprise and delight benefits, it’s important to notify customers of the new reward through a workflow triggering an email message from your provider’s system.

  • Membership pass: The membership pass can also be used as a digital loyalty card. It identifies the customer by their ID enabling customers to earn points in your physical stores through purchases and check-ins at offline locations. Upon enrollment in the loyalty program, customers automatically receive an email containing a barcode or QR code representing their unique customer ID. Additionally, you have the option to include the membership pass in the registration email sent by your email provider. Customers can also access and download their membership passes at any time by logging into the membership site.

  • Event pass: Similar to coupons, event passes guarantee entry into a specified offline event. Please note that both coupon and event passes can only be assigned to Coupon types of rewards. Therefore, both coupons and event rewards should be configured as coupon-type rewards in the Reward editor.
    There are visual distinctions between the passes on Apple Passes: coupons have a perforated edge at the top, membership passes are flat, and ticket passes have a small cutout.

• Tick the checkbox to enable Apple Wallet

• Tick the checkbox to enable Google Pay

• Select user group(s)
  If you use the User group module and have enabled the Pass templates entity in the settings, you need to assign a group to the template. Unauthorized users will not be able to access the pass template in the Management UI.

• Click Select at the bottom of the page to continue

Pass Template

Template of the Apple Wallet

Basic information

• Variant group id
  Add the template to a variant group by selecting a previously added group or by entering a new group ID. This enables workflows to look up a pass based on the variant group and switch the template of an assigned pass to another template within the same variant group if necessary (eg., switching the template of the membership pass when the customer upgrades from Silver membership tier to Gold membership tier).

• Name
  Enter the administrative name of the pass template that appears in the Management UI.

• Organization name
  This name will appear in the header of the push notifications sent to the customers' mobile devices. This setting is useful if you use the Multi-accounts module and want to clarify which account the current pass update belongs to.

Colors

• Choose a background color

• Select a label color
  This will be the color of the label texts of the fields on the front of the pass, except for the primary fields. For Apple passes, the label for primary fields can be changed using the foreground color.

• Select a foreground color
  This will be the color of all texts other than labels on the front of the pass.

Assets and Retina assets

• Upload an icon
  The icon image is displayed along with push notifications and lock-screen notifications.

• Upload your logo
  The logo image is displayed in the top left corner of the pass.

• Upload the strip image
  The strip image is displayed under the logo and the header field, behind the primary fields as a background image. The image will be center-cropped if it is too large.

For Apple passes, it’s also possible to upload retina (HiDpi) images to improve the visual quality of passes. It depends on the resolution of the customer’s mobile device if the standard or the retina assets are displayed. While uploading standard assets is mandatory, adding retina assets is optional.

Asset size requirements:

• Click the Next button at the bottom of the page to continue

Template of the Google Pay

Basic information

• Variant group id
  Add the template to a variant group by selecting a previously added group or by entering a new group ID. This enables workflows to look up a pass based on the variant group and switch the template of an assigned pass to another template within the same variant group if necessary (e.g., switching the template of the membership pass when the customer upgrades from Silver membership tier to Gold membership tier).

• Name
  Enter the administrative name of the pass template that appears in the Management UI.

• Organization name
  This name will appear in the header of the push notifications sent to the customers' mobile devices. This setting is useful if you use the Multi-accounts module and want to clarify which account the current pass update belongs to.

Tier information

available for Membership passes only

• Tier Label
  The designation for the tier displayed above the actual tier, for example, Tier Status or Tier.

• Tier
  Insert the variable specifying the name of the customer's current tier status in the applicable tier structure.

Messages and contact information

available for Membership passes only

• Message
  Add the array of personalized messages displayed in the app.

• Text modules Enter general text content you’d like to share.

• Links

  Add links to your pass.

Colors

• Choose a background color

Assets

• Upload an icon
  The icon image is displayed along with push notifications and lock-screen notifications.

• Upload your logo
  The logo image is displayed in the top left corner of the pass.

• Upload the strip image
  The strip image is displayed under the logo and the header field, behind the primary fields as a background image. The image will be center-cropped if it is too large.

Asset size requirements:

• Click the Next button at the bottom of the page to continue

Pass content

Content of the Apple Wallet Passes

Header

• Add logo text
  The text will appear on the logo image

Apple Wallet Fields

• Header fields

• Primary fields

• Secondary fields

• Auxiliary fields

• Back fields

To access the backside of the pass, click on the pass preview. Unlike the front side, which has limited space, the backside of the pass is scrollable, allowing for the inclusion of additional information. This space is ideal for providing details such as Terms of Use or customer service contact information.

Apple passes have up to 3 header fields, 1 primary field, up to 4 secondary fields, and up to 4 auxiliary fields. The maximum number of combined secondary and auxiliary fields is 4. However, the number of back fields is unlimited.

Please note that the number of fields displayed on the pass may vary based on the length of the text in each field. If the text exceeds a certain length, some fields may not be fully displayed on the pass

Each type of field has the following settings to define:

• Label of the field

• Value of the field
  In addition to general text, you can include expressions, for example, the customer’s {} current level or{} a number of points.

• Change message
  Enter the text for the notification which will appear on the customer’s screen when the field gets updated.

To remove a field, click the X icon on the right-hand side of the corresponding field.

Basic information

• Add a description
  The description appears on the back side of the Apple Pass.

• Select the relevant date – for Event-type passes only
  Choose the date and time when the pass becomes relevant, such as the start time of an event.

Barcode

• Select the type of code
  Choose between barcode or QR code format.

• Add the code content
  Enter general text, a URL, or customer and coupon properties. Note that the pass is not assigned if the barcode content is empty.

• Enter alternative text
  This text will appear under the code.

Content of the Google Pay Pass

Basic information

• Merchant name
  Enter the name of the brand.

• Offer title - for Coupon- and Event-type passes only
  Enter the name of the coupon.

• Balance - for Coupon-type passes only
  The value of the coupon.

• Program name - for Membership-type passes only
  Enter the name of the program that the pass allows the customer to participate in.

• Loyalty points label and balance - for Membership-type passes only

• Secondary loyalty points label and balance - for Membership-type passes only

Offer information

for Coupon- and Event-type passes only

• Offer provider
  Enter the name of the brand that provides the coupon.

• Details
  Provide all relevant details about the offer.

• Disclaimer
  Enter any necessary terms and conditions for the offer.

Member information

for Membership-type passes only

• Member name label and member name

• Membership ID label and ID

Messages and contact information

• Messages
  Add the array of personalized messages displayed within the app.

• Text modules
  Enter general text content you’d like to share.

• Links
  Add links to your pass.

Offer expiration

for Event-type passes only

• Start date and end date
  Select the timeframe during which the pass is valid for event check-ins.

Barcode

• Select the type of code
  Choose between a barcode or QR code format.

• Add the code content
  Input general text, a URL, or customer and coupon properties.

• Enter alternative text
  This text will be displayed below the code.

Once you’ve finalized the content settings of the Google Pass and/or Apple pass are finalized, click Next at the bottom of the page.

Notifications EARLY ACCESS

Push notifications

The beta version includes push notifications delivered as wallet notifications displayed on the lock screen.

Tick the box to enable push notifications. These can be triggered using Antavo's Workflows module by adding a Push notification action node.

Please note, that the push notifications services have to be configured to make the beta version of push notifications operational. If you can see an alert on the top of the page referring to a missing service configuration, please make sure you have the wallet processQueue services configured.

Locations

• Locations

  • Select locations from the dropdown list that should trigger a push notification
    Learn how to add locations under the Locations section of this manual.

  • Click the Add location button

  • Add the text of the message in the field that appears

• Trigger distance
  Enter the distance of the location where the notification should be triggered.

Beacons

• Beacons

  • Select the beacons that should trigger notifications
    Learn more about how to add beacons and the content of the beacon-triggered notification under the Beacons section of this manual.

  • Click the Add beacon button

  • Add the text of the message in the field that appears

Overview

Before saving the newly created pass, a final preview shows what customers will see on their mobile phones. If you’d like to make changes, navigate back to any stage of the pass setup. If you’re satisfied with the end result, click the Create button at the bottom of the page.

The new pass will immediately appear in the list on the Passes page.

Activate the pass

After saving for the first time, the status of the new pass is draft. You can activate the pass right away using the Set active button on the upper right-hand side of the setup page and confirm the activation in the dialog that subsequently appears.

If you want to deactivate an active pass, you can do so by clicking the Set inactive button. This will change the pass status to inactive, which means it appears only in the list on the module configuration page in the Management UI.

Locations EARLY ACCESS

The beta version provides the Locations tab that lists the previously saved locations serving as references to send location-triggered push notifications.

To add a new location:

• Click the Add new location button on the sidebar

• Add the name of the location

• Enter the location coordinates, or use the search field to define the location

• Click the Save button

Beacons DEPRECATED

In addition to location-based notifications, you can use beacons to trigger push messages. Beacons are Bluetooth devices that retain a field around themselves transmitting that they are there. When a mobile enters this field and Bluetooth is enabled on the customer’s phone, the pass can pick up on that and display a notification associated with the field.

To add a new beacon:

• Enter the unique name of the beacon

• Add the major identifier of the beacon

• Add the miner identifier of the beacon

• Enter the Proximity UUID  

• Add the unique identifier of the beacon

• Enter the text of the push notification that the beacon should trigger. This text will be displayed on the lock screen when the pass is currently relevant.

Settings

Template settings

• Select the default membership pass template from the dropdown menu.

Apple developer settings

Before you start using Apple Passes in your loyalty program, fill in the details of your Apple Developer Certificate.

• Select the update service type

• Add your Team Identifier

• Add your Pass Type Identifier

• Add the name of your certificate

• Add the password you specified when generating the certificate.

Google developer settings

If you’d like to use the Google Pay passes, please enter the following Google credentials.

• Project identifier

• Private key identifier

• Private key

• Client email

• Client ID

General Settings

• Define the time period when the tokens of pass download links are valid after the links are generated (e.g., +2 days).

API

The customers/customer_id/wallet API endpoint is capable of returning the pass download link and the download deep link* so that you can display the pass on the membership site. However, this data is not included in the response by default. Please ensure you tick the checkbox(es) if you need Antavo to provide this information in the API response.

* available for iframe users only

Pass emails DEPRECATED

Both the Membership pass and Reward pass email can be customized with Antavo’s email editor, which you can find in the Settings menu:

• Navigate to the Settings page of the Antavo Management UI

• Click Emails on the left side of the page

• Search for the Membership pass email to customize the membership pass email, or the Pass email to customize the reward pass email

• Click the hamburger button and select the Edit option

• Edit all the texts using our WYSIWYG editor by clicking on the content of the email

• Use our built-in HTML and CSS editor for further customization

You can send a test email to yourself to see how the email will look from a loyalty member’s perspective. To do so, click the hamburger button on the Emails page and select the Test send option.