Search

Setting up Digital Wallet in Config Hub

Digital Wallet in Config Hub is where you configure the credentials and certificates required to issue and manage digital wallet passes in Voyado Engage. You must complete this setup before you can distribute cards to members.

Voyado will never need access to your Apple or Google accounts. To issue Wallet passes, Voyado only needs the certificates, keys, and permissions specific to the Wallet integration itself.

Apple Wallet

For Apple, we use a certificate and private key that are exclusively used for issuing Wallet passes. These do not grant access to your Apple account or any other Apple services. We recommend creating a dedicated certificate and key pair used solely for Wallet passes.

Create the account using an authorized company signatory. This will help expedite the process with Apple.

Google Wallet

For Google, we recommend creating a separate Google Cloud project and a dedicated service account for the Wallet integration. The service account is only granted the permissions you explicitly assign to it, and does not automatically gain access to other resources in your Google environment or organization. The only permission required is Wallet Object Issuer. By scoping permissions to what is strictly needed for Google Wallet, the integration can be fully isolated from your other systems.

Voyado's access

Voyado is only granted the rights required to create and update Wallet passes on your behalf. We do not have access to your Apple or Google accounts beyond what is necessary for this integration.

Prerequisites

Before starting, make sure you have the following accounts and access in place:

For Apple Wallet:

  • An active Apple Developer Account ($99/year) — register at developer.apple.com
  • Access to Certificates, Identifiers & Profiles in your Apple Developer account

For Google Wallet:

Opening Config Hub

  1. In Engage, go to Administration > Config Hub > Marketing & Communications > Wallet.

Apple Wallet configuration

Each setting depends on the previous one.

1. Team identifier

Your 10-character Team ID links your Apple Developer account to Voyado Engage.

Where to find it:

  1. Log in to developer.apple.com.
  2. Navigate to Account > Membership Details.
  3. Copy the Team ID value.

In Config Hub:

  1. Paste your Team ID into the Team Identifier field.
  2. Click Save.

2. Pass type ID

The Pass Type ID identifies the specific pass type used for your wallet passes.

How to create one:

  1. In your Apple Developer account, navigate to Certificates, Identifiers & Profiles > Identifiers.
  2. Click + and select Pass Type IDs.
  3. Enter a description and a unique identifier. By convention this follows the format pass.com.yourcompany.yourapp.
  4. Click Register.

In Config Hub:

  1. Paste your Pass Type ID into the Pass Type ID field.
  2. Click Save.

3. Certificate signing request (CSR)

A CSR is required to generate your Apple certificate. Voyado Engage generates the CSR for you.

  1. In Config Hub, click Generate CSR under Certificate Signing Request.
  2. Download the generated .csr file.
  3. Go to your Apple Developer account and navigate to Certificates > Create Certificate.
  4. Select Pass Type ID Certificate as the certificate type.
  5. Upload the .csr file you downloaded from Config Hub.
  6. Download the resulting .cer certificate file from Apple.
Keep the .cer file ready — you will upload it in the next step.

4. Certificate

Upload the .cer file you received from Apple after submitting the CSR.

  1. In Config Hub, choose your file and click Upload.
  2. Click Save.
Apple certificates expire after one year. Set a reminder to renew your certificate before expiry. An expired certificate will prevent pass updates from being delivered to members' devices. To renew, repeat steps 3 and 4 above.

5. APNs key ID

The APNs (Apple Push Notification service) Key ID enables push updates to be delivered to Apple Wallet passes, for example when a member's points balance or voucher changes.

Where to find it:

  1. In your Apple Developer account, navigate to Keys.
  2. Select your APNs key, or create a new one if you don't have one. Set the key (it will be used in both Sandbox and Production).
  3. Copy the Key ID.

In Config Hub:

  1. Paste the Key ID into the APNs Key ID field.
  2. Click Save.

6. APNs key

Upload the .p8 key file associated with your APNs Key ID.

Where to find it:

  • The .p8 file is downloaded when you first create the APNs key in your Apple Developer account.
  • The file can only be downloaded once. If you have lost it, you must create a new APNs key in your Apple Developer account and repeat this step with the new key and Key ID.

In Config Hub:

  1. In Config Hub, choose your file and click Upload.
  2. Click Save.

Google Wallet configuration

1. Use Google's official documentation

Please follow Googles official documentation for the setup. After you've followed the below two documentation pages, you can go ahead and add the information in config hub.

  1. Setting up a Google Wallet API Issuer account
  2. Generating Google Wallet REST API authentication credentials

Two steps inside this documentation are easy to miss but will block your setup if skipped:

  • Enable the Google Wallet API for your project — do this by visiting https://console.developers.google.com/apis/api/walletobjects.googleapis.com/overview?project={PROJECTID}, where {PROJECTID} is your organisation's project ID.
  • Get publishing rights — all new accounts start in "demo mode," where passes can only be issued to Admin/Developer roles or test accounts. Follow the "Get publishing access" steps in the Google Wallet API Dashboard to lift this restriction.
Confirm both of these are done before moving on to step 2.

2. Add values to Config Hub

There are two values you'll need to add to Config Hub:

2.1 Issuer ID

Your Issuer ID identifies your business in Google Wallet and is required to issue passes.

Where to find it:

  1. Log in to the Google Pay & Wallet Console.
  2. Navigate to your account details.
  3. Copy your Issuer ID.

In Config Hub:

  1. Paste the Issuer ID into the Issuer ID field.
  2. Click Save.

2.2 Service account

A Google service account authorizes Voyado Engage to issue and update Wallet passes on your behalf.

How to set it up:

  1. In the Google Cloud Console, navigate to IAM & Admin > Service Accounts.
  2. Select an existing one that was created by the official Google documentation.
  3. Navigate to the service account's Keys tab.
  4. Click Add Key > Create new key and select JSON.
  5. Download the JSON key file.

In Config Hub:

  1. Click Edit under Service Account.
  2. Upload the JSON key file.
  3. Click Save.
Store your JSON key file securely. Anyone with this file can issue and update passes on your behalf.

Important points

Two important points about Google Wallet are:

Enable Google Wallet API

The organisation needs to have the Google Wallet API enabled. Enable it by visiting https://console.developers.google.com/apis/api/walletobjects.googleapis.com/overview?project={PROJECTID}, where {PROJECTID} is your organizations project ID.

Get publishing rights

All new accounts are created in 'demo mode'. In demo mode, you can create passes, but you won't have publishing access. This means the passes you create can only be issued to users who have the 'Admin' or 'Developer' role, or who have been added as a test account to your Issuer account. To enable publishing access, follow the steps under 'Get publishing access' in the Google Wallet API Dashboard.

Was this article helpful?

/