public final class WalletExtension

Publishes card data to the Apple Wallet issuer-provisioning extension so users can add the issuer’s cards to Apple Wallet from inside the Wallet app (“From apps on your iPhone”). iOS only; on other platforms isSupported() returns false and all methods are no-ops.

How it works

The Wallet extension runs in a separate process, launched by the Wallet app, usually while your app is not running. It cannot call into your Java code. Instead your app pre-publishes the list of available cards (and an auth token) with this class; the data is stored in the shared App Group container where the generated extension reads it. The final provisioning step - producing the encrypted pass payload - is performed by your issuer backend: the extension POSTs Apple’s certificates/nonce plus the card identifier and auth token to the HTTPS endpoint configured in the ios.wallet.issuerEndpoint build hint, which must respond with JSON {"activationData", "encryptedPassData", "ephemeralPublicKey"} (base64).

Call [#setPassEntries(WalletPassEntry[])] whenever the user’s card list changes (e.g. after login) and keep a fresh auth token published with setAuthToken(java.lang.String); call clear() on logout.

Enabling the extension (no native code needed)

Add these build hints to the iOS build:

• ios.wallet.extension=true - generates the non-UI Wallet extension
• ios.wallet.appGroup=group.com.mycompany.myapp - shared App Group id
• ios.wallet.issuerEndpoint=https://... - issuer backend endpoint
• ios.wallet.includeUI=true + ios.wallet.authEndpoint=https://... - optional in-Wallet login screen, only needed when you report setRequiresAuthentication(boolean) true instead of keeping a token
• ios.wallet.*Inject hints - inject custom Objective-C at key points

Each extension needs its own App ID and provisioning profile carrying the restricted com.apple.developer.payment-pass-provisioning entitlement, which Apple grants per-app on request. For cloud builds either place the .mobileprovision files in src/main/resources and name them in the ios.wallet.nonuiProvisioningProfile / ios.wallet.uiProvisioningProfile hints, or host them at the URLs given in the ios.wallet.nonuiProvisioningURL / ios.wallet.uiProvisioningURL hints. The card network must also list the extension App IDs in the pass metadata (associatedApplicationIdentifiers) or Wallet never invokes the extension.

Bringing your own extension

If you already have Xcode extension targets (e.g. from an issuer SDK vendor or an existing native app), skip the ios.wallet.* hints and copy each extension into ios/app_extensions/<Name>/ in your project instead: its sources, Info.plist, <Name>.entitlements, an optional buildSettings.properties with Xcode build settings (set IPHONEOS_DEPLOYMENT_TARGET=14.0 for Wallet extensions) and the extension’s .mobileprovision for cloud device builds.