Step 1: Set Up a Google Wallet API Account for the Business

Google Developer Account

• First, you need to have a Google Developer Account. If you don’t have one, you can sign up at GoogleDeveloper Console.

• Create a Google Cloud Project:

  • Once you have a developer account, create a new project in the Google Cloud Console.
  • This project will be used to enable the Google Wallet API and manage the necessary credentials.

• Enable Google Wallet API:

  • Go to the APIs & Services section in the Google Cloud Console.
  • Search for Google Wallet API (specifically, Google Wallet Objects API) and enable it for your project.

• Set Up API Credentials:

  • Under APIs & Services, navigate to Credentials.
  • Create a Service Account that will be used to authenticate your app and interact with Google Wallet.
  • Create a Service Account: Choose a role with sufficient privileges, such as Project > Owner.

• Download the Service Account JSON Key File: This file contains the private credentials needed for API authentication and will be uploaded when creating the loyalty class.

  
  

Step 2: Obtain the Issuer ID

Go to the Google Pay & Wallet console and sign in with a Google Account you want to have the 'Admin' role for your Issuer account.

To use Google Wallet for loyalty passes, you need an Issuer ID which uniquely identifies your business. This ID is associated with the service account that was created in the previous step.

• Create a Wallet Object in Google API:
  • Once you have set up the project and the credentials, you can create a Loyalty Class (AndroidPayLoyaltyClass) via Google Wallet API.
  • The first time you create a Loyalty Class, Google Wallet will provide an Issuer ID that identifies the issuer of the loyalty passes.
• Issuer ID Location:
  • The Issuer ID will be part of the response when you create your first loyalty object (or class) through the Google Wallet API. You can retrieve it from the API response or from the Google Wallet dashboard.
• Issuer ID Usage:
  • The Issuer ID is used in the AndroidPayLoyaltyClass object to identify which business is issuing the loyalty passes. This ID is passed as part of the API call when pushing data to Google Wallet.

Step 3: Generate and Download the Service Account JSON Key File

• Download JSON Key File:
  • After creating the service account in the Google Cloud Console, you can download the JSON key file. This file contains the credentials necessary to authenticate your application with the Google Wallet API.
  • The JSON key file contains critical information like:
    • client_email: The email address associated with the service account.
    • private_key: The private key used to sign API requests.
    • project_id: The unique identifier for the Google Cloud project.
    • private_key_id: The private ID used to sign API requests.
    • client_id: The ID associated with the service account.
• JSON File Location:
  • When you create a service account in Google Cloud Console, you will be given an option to download a JSON file. This file is essential for authenticating API requests to Google Wallet.
  • Ensure that this JSON file is securely stored and uploaded when creating the loyalty class in the system.

A Loyalty Pass is used to identify the loyalty guest at the POS. Today, the loyalty pass provides the POS access to the guest's available rewards for redemption. ​Once a guest adds a Loyalty Pass to their digital wallet, it remains until the guest deletes it. It does not expire.​ Your brand can prompt a guest to join the loyalty program and add the pass when the guest taps to pay using their digital wallet at the POS.

Under Wallet and Passes > Passes, click Create Loyalty Pass under Google Loyalty Pass. 

Front of Pass

Use the following fields to create the Design and Content of your Loyalty Pass. A preview of your changes is available on the right of the screen. 

Note: The above example does not display a "Main Image."

• Hero image: Add an image file that appears at the base of the Google pass. 
  

• Title: Enter any text you want to appear next to your Title Image. For example, if your logo only contains the initials of your brand, you may want to include your brand's full name as text. 
  Note: If you add a Main Image (list below), the title will not appear.
  

• Subtitle: Enter the name of your brand's loyalty program.
  

• Background Color: Enter the hex code of the color for the full background of the pass. 
  

• Main Image: Add an image file that appears at the top of the pass.
  Note: If you use a Main Image, any Title/Title image will not appear.
  

• Title Image: Add an image file that will appear next to the Title text, for example, your brand's logo. 
  

• Barcode type: Select between a QR code or Barcode. This code will always appear on your pass details page. 

  It is recommended to use a QR code, as they are more widely used.

• Primary loyalty points: Select this field to display information about the guest's loyalty account balance.
  • Primary loyalty points label: Enter the label for what information is shown in the primary field. For example, "Balance."
  • Primary loyalty points value: You can use {{{current_account_balance}}}, {{{current_points_balance}}} and {{{banked_rewards}}} as a dynamic tag for this field.
    
• Secondary loyalty points: Select this field to display the guest's name. 
  • Secondary loyalty points: label: Enter the label for what information is shown in the secondary field (just below the primary field, to the left.) For example, "Name". 
  • Secondary loyalty points: value: You can use {{{email}}}, {{{first_name}}} and {{{last_name}}} as a dynamic tag(s) for this field.
    

Click Next.

Pass Details

• Account name label: Use this field to label the section that shows the guest's name.

• Account name value: Enter the tags you wish to display in this section. Either {{{first_name}}} and/or {{{last_name}}}. 
  

• Account ID label: Use this field to label the section that shows the guest's email.

• Account ID value: Enter {{{email}}} in this section.
  

• Description: Enter a description of your Google Pass that appears on the pass details page. Keep this short, under 25 characters. 
  

• Available rewards limit: Enter the number of rewards the pass details will display, with a maximum of 4.
  

  Note: Rewards on the back of the pass are prioritized by the soonest expiration and refresh automatically. No configuration is required. Newly earned or gifted rewards appear on the back of the pass within 12 hours.

  • Marketing label:  Use this field to label or name your Loyalty Program. Enter in text or a dynamic tag as needed. If you leave this blank, your business name will be shown.
  • Marketing description:  Use this field to describe your Loyalty Program. Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 
    

• Phone: Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 

• Address:  Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 

• Web URL: Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 
  

Click Next.

Settings

• Reward Field Message: Enter the text you want guests to receive as a push notification when a reward is added to their Google Wallet Loyalty Pass. If you leave this field blank, the platform uses the default notification text automatically.
  
• Allow personalize pass: Enable this to allow push notifications to be sent to the guest to prompt them to add your brand's Google Pass to their Wallet, if not already done. 
  • Personalize description: Enter the text that would appear in the push notification described above.
  • Personalize terms and conditions: Enter any links to the terms and conditions that would accompany the push notification described above. 
    
• Near Field Communication (NFC) capability: Enable this for full NFC capability. If left off, a QR code or barcode will appear on your pass.  
  
• Android pay issuer ID: Enter your business's Issuer ID created in Step 2: Obtain the Issuer ID above.
  
• User Identifier: Use the drop-down menu to select the user identifier (like User Code or phone number) that will then be used to generate the QR Code or Barcode on the pass. 
  
• Service account: Attach your Google Cloud file (JSON only), obtained in Step 3: Generate and Download the Service Account JSON Key File above.
  
• Review status: Select the status of your pass for Google's review process.
  • Draft: Select Draft to indicate that the pass is not ready to be sent to Google for review. 
  • Under Review: Select Under Review and then Finish on the next page to send the pass to Google for review and approval. 

Once approved, this field will be grayed out and show as Approved.

Click Next.

Review

The review page shows all the selections you made above. Review the content and the previews shown on the right. 

• Click Back to return to a specific page to make changes. 
• Click Finish to complete your Google Loyalty Pass and send the pass for review to Google.

An Offer Pass is a digital representation of a reward, redemption code, or coupon/promo. Once a guest adds it to their Google Wallet, it can be applied during a transaction at the POS. ​ Offer Passes have an expiry that aligns with the redeemable's expiry setting. ​You can send Offer Passes to guests via email or SMS.​

Under Wallet and Passes > Passes, click Create Offer Pass under Google Offer Pass. (Or Edit Offer Pass if the initial setup has been done.) 

Front of Pass

Use the following fields to create the Design and Content of your Loyalty Pass. A preview of your changes is available on the right of the screen. 

Note: The above example does not display a "Main Image."

• Hero image: Add an image file that appears at the base of the Google pass. 
  

• Title: Enter any text you want to appear next to your Title Image. For example, if your logo only contains the initials of your brand, you may want to include your brand's full name as text. 
  Note: If you add a Main Image (list below), the title will not appear.
  

• Subtitle: Enter the name of your brand's loyalty program.
  

• Background Color: Enter the hex code of the color for the full background of the pass. 
  

• Main Image: Add an image file that appears at the top of the pass.
  Note: If you use a Main Image, any Title/Title image will not appear.
  

• Title Image: Add an image file that will appear next to the Title text, for example, your brand's logo. 
  

• Barcode type: Select between a QR code or Barcode. This code will always appear on your pass details page. 

  It is recommended to use a QR code, as they are more widely used.

• Primary field: Select this field to display the offer name on the front of the pass. When a Display Name is configured on the associated Coupon or Promo Campaign, that name appears here. If no Display Name is set, the coupon or promo code appears in this field instead.
  • Primary field label: Enter the label for what information is shown in the primary field. For example, "Offer Name."
    
• Secondary field: Select this field to display the status of the reward.
  • Secondary field label: Enter the label for what information is shown in the secondary field (just below the primary field, to the left.) For example, "Status". 
    
• Auxiliary field: Select this field to show the guest's email address. 
  • Auxiliary field label: Enter the label for what information is shown in the auxiliary field (just below the primary field, to the right.) For example, "Expires at". 
    

Click Next.

Pass Details

• Account name label: Use this field to label the section that shows the guest's name.
• Account name value: Enter the tags you wish to display in this section. Either {{{first_name}}} and/or {{{last_name}}}. 
  
• Account ID label: Use this field to label the section that shows the guest's email.
• Account ID value: Enter {{{email}}} in this section.
  
• Description: Enter a description of your Google Pass that appears on the pass details page. Keep this short, under 25 characters. 
  
  • Marketing label:  Use this field to label or name your Loyalty Program. Enter in text or a dynamic tag as needed. If you leave this blank, your business name will be shown.
  • Marketing description:  Use this field to describe your Loyalty Program. Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 
    
• Web URL: Enter in text or a dynamic tag as needed. If you leave this blank, this field will not appear on the details page. 
  

Click Next.

Settings

• Allow personalize pass: Enable this to allow push notifications to be sent to the guest to prompt them to add your brand's Google Pass to their Wallet, if not already done. 
  • Personalize description: Enter the text that would appear in the push notification described above.
  • Personalize terms and conditions: Enter any links to the terms and conditions that would accompany the push notification described above. 
    
• Near Field Communication (NFC) capability: Enable this for full NFC capability. If left off, a QR code or barcode will appear on your pass. Coming Soon! NFC is currently not available for Offer Passes.
  
• Android pay issuer ID: Enter your business's Issuer ID created in Step 2: Obtain the Issuer ID above.
  
• User Identifier: Use the drop-down menu to select the user identifier (like User Code or phone number) that will then be used to generate the QR Code or Barcode on the pass. 
  
• Service account: Attach your Google Cloud file (JSON only), obtained in Step 3: Generate and Download the Service Account JSON Key File above.
  
• Review status: Select the status of your pass for Google's review process.
  • Draft: Select Draft to indicate that the pass is not ready to be sent to Google for review. 
  • Under Review: Select Under Review and then Finish on the next page to send the pass to Google for review and approval. 

Once approved, this field will be grayed out and show as Approved.

Click Next.

Review

The review page shows all the selections you made above. Review the content and the previews shown on the right. 

• Click Back to return to a specific page to make changes. 
• Click Finish to complete your Google Loyalty Pass and send the pass for review to Google.