Setting up Apple Wallet

For Apple, Voyado uses 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. The recommended approach is to create a dedicated certificate and key pair that is used solely for Wallet passes.

Create the account using an authorized company signatory. This will speed up the process with Apple.

Prerequisites

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

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

Configuration

You'll be doing the configuration in the Customer Engagement Config Hub. You'll find it in Customer Engagement at Administration > Config Hub > Marketing & Communications > Wallet.

Each setting in the configuration is dependant on the previous one.

1. Team identifier

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

Where to find it:

  1. Log into 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 unique identifier. By convention the indentifier 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. Customer Engagement 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 the certificate, just 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 same key to 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.

Was this article helpful?

/