iOS

The Push Provisioning SDK supports iOS for Apple Pay push provisioning.

Prerequisites

• iOS 13.0+
• Xcode 14.0+
• Swift 5.0+

• For full Apple Pay functionality, run on physical devices.
• Do production testing in the Production Environment on production devices, using Ad Hoc provisioning profiles, TestFlight, or the App Store. Do Pre-Production testing from Xcode.

Push Provisioning Access

Apple Pay push provisioning requires a special Apple entitlement named com.apple.developer.payment-pass-provisioning. Request it by emailing [e-mail].

In your email, include the following information:

• Your app name.
• Your Developer Team ID, available in Apple Developer Membership.
• ADAM ID (your app's unique numeric ID), found in App Store Connect or in the App Store linked to your app, for example, https://apps.apple.com/app/id123456789.

Once Apple grants the entitlement, add the distribution entitlement to a provisioning profile. Use the same profile to develop the app in Xcode.

In your project, open or create the entitlements file. Add the com.apple.developer.payment-pass-provisioning key with a Boolean value YES.

Then, in your app target, go to Build Settings > Signing > Code Signing Entitlements. Ensure it points to the entitlements file.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>com.apple.developer.payment-pass-provisioning</key>
    <true/>
  </dict>
</plist>

Also add the In-App Provisioning capability in the app configuration:

Add the In-App Provisioning capability.

For more details about how to set up Apple Pay, see Setting Up Apple Pay.

Integrating Push Provisioning SDK

1. Download the latest release of Push Provisioning SDK and extract the ZIP file.
2. Go to the Xcode project folder, and create a new folder "TPCSDK".
3. Put the extracted TPCSDKSwift.xcframework in the folder.
4. In the app target, select General > Frameworks, Libraries, and Embedded Content, click + > Add Other > click Add Files.
5. Select the TPCSDKSwift.xcframework and click Open.

Add the XCFramework to your app target.

Ensure that Embed & Sign is selected as follows:

Set the framework to Embed & Sign.

If you use an Objective-C project, set Framework Search Paths and Header Search Paths.

Set Framework Search Paths.

Set Header Search Paths.

Swift

Configuration

Add the following configuration to your application to use the Push Provisioning SDK.

Import the TPCSDKSwift module in your AppDelegate.swift:

import TPCSDKSwift

Objective-C

Configuration

Import a header into the project

1. Create a Bridging-Header.h file by creating a Swift file.
2. Import the TPCSDKSwift header file in Bridging-Header.h.

Add the configuration code to your application

Import the TPCSDKSwift module in your AppDelegate:

#import <TPCSDKSwift-Swift.h>

To enable Swift framework support, ensure that the following project definitions exist:

SWIFT_OBJC_BRIDGING_HEADER=Project/Project-Bridging-Header.h

SWIFT_VERSION=5.0

ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES=YES

Note

Due to a bug in Xcode, you must create at least one Swift file (it can be empty) in the project. Include it in Build Phases > Compile Sources.

Configure the Push Provisioning SDK in your application:didFinishLaunchingWithOptions: delegate function.

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
 
    let tpcIssuerId = "TPC_ISSUER"
    do {
      try TPCSDK.configure(variant: .PPROD,
                          issuerId: tpcIssuerId)
      // Apple Pay and provisioning is supported
    } catch {
      // Handle TPCError
    } 
    
    return true
  }

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  // Override point for customization after application launch.
  NSError *error = nil;
  [TPCSDK configureWithVariant:SdkVariantPROD issuerId:@"TPC_ISSUER" error:&error];
  if (error) {
      NSLog(@"Handle TPCError");
  }
  
  return YES;
}

Note

All PKPassLibrary operations (isCardDigitized, getCardDigitizationResult, activatePass, ...) are not thread-safe. Run them on a single thread. https://developer.apple.com/documentation/passkit/pkpasslibrary