App Services · IOS API REFERENCE

PassKit

Process Apple Pay payments in your app, and create and distribute passes for the Wallet app.

163 types

817 callable entries

77 skipped

91% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

JPKIPassContents

struct · iOS 18.0+

JPKIPassContents.AuthenticationRequest

struct · iOS 18.0+

JPKIPassContents.Certificate

struct · iOS 18.0+

JPKIPassContents.Error

enum · iOS 18.0+

JPKIPassContents.Identity

protocol · iOS 18.0+

JPKIPassContents.Signature

struct · iOS 18.0+

JPKIPassContents.SigningIdentity

struct · iOS 18.0+

JPKIPassContents.SigningIdentity.AuthenticationType

enum · iOS 18.0+

JPKIPassContents.SigningIdentity.IdentityType

typealias · iOS 18.0+

JPKIPassContents.UserIdentity

struct · iOS 18.0+

JPKIPassContents.UserIdentity.AuthenticationType

enum · iOS 18.0+

JPKIPassContents.UserIdentity.IdentityType

typealias · iOS 18.0+

PKAddCarKeyPassConfiguration

class · iOS 13.4+

PKAddIdentityDocumentConfiguration

class · iOS 18.0+

PKAddIdentityDocumentMetadata

class · iOS 26.0+

PKAddIdentityDocumentType

enum

PKAddPassButton

class · iOS 9.0+

PKAddPassButtonStyle

enum · iOS 9.0+

PKAddPassesViewController

class · iOS 6.0+

PKAddPassesViewControllerDelegate

protocol

PKAddPassMetadataPreview

class · iOS 18.0+

PKAddPaymentPassError

enum · iOS 9.0+

PKAddPaymentPassRequest

class · iOS 9.0+

PKAddPaymentPassRequestConfiguration

class · iOS 9.0+

PKAddPaymentPassStyle

enum · iOS 12.0+

PKAddPaymentPassViewController

class · iOS 9.0+

PKAddPaymentPassViewControllerDelegate

protocol · iOS 9.0+

PKAddressField

struct · iOS 8.0+ · Deprecated in iOS 11.0

PKAddSecureElementPassConfiguration

class · iOS 13.4+

PKAddSecureElementPassError

struct · iOS 13.4+

PKAddSecureElementPassError.Code

enum · iOS 13.4+

PKAddSecureElementPassViewController

class · iOS 13.4+

PKAddSecureElementPassViewControllerDelegate

protocol · iOS 13.4+

PKAddShareablePassConfiguration

class · iOS 14.0+

PKAddShareablePassConfigurationPrimaryAction

enum · iOS 14.0+

PKApplePayLaterAvailability

enum · iOS 17.0+

PKAutomaticPassPresentationSuppressionResult

enum · iOS 9.0+

PKAutomaticReloadPaymentRequest

class · iOS 16.0+

PKAutomaticReloadPaymentSummaryItem

class · iOS 16.0+

PKBarcodeEventConfigurationDataType

enum · iOS 14.0+

PKBarcodeEventConfigurationRequest

class · iOS 14.0+

PKBarcodeEventMetadataRequest

class · iOS 14.0+

PKBarcodeEventMetadataResponse

class · iOS 14.0+

PKBarcodeEventSignatureRequest

class · iOS 14.0+

PKBarcodeEventSignatureResponse

class · iOS 14.0+

PKContact

class · iOS 9.0+

PKContactField

struct

PKDateComponentsRange

class · iOS 15.0+

PKDeferredPaymentRequest

class · iOS 16.4+

PKDeferredPaymentSummaryItem

class · iOS 15.0+

PKDisbursementError

struct · iOS 17.0+

PKDisbursementError.Code

enum · iOS 17.0+

PKDisbursementErrorKey

struct

PKDisbursementRequest

class · iOS 17.0+

PKDisbursementSummaryItem

class · iOS 17.0+

PKEncryptionScheme

struct

PKIdentityAnyOfDescriptor

class · iOS 26.0+

PKIdentityAuthorizationController

class · iOS 16.0+

PKIdentityButton

class · iOS 16.0+

PKIdentityButton.Label

enum · iOS 16.0+

PKIdentityButton.Style

enum · iOS 16.0+

PKIdentityDocument

class · iOS 16.0+

PKIdentityDocumentDescriptor

protocol · iOS 16.0+

PKIdentityDocumentMetadata

class · iOS 18.0+

PKIdentityDriversLicenseDescriptor

class · iOS 16.0+

PKIdentityElement

class · iOS 16.0+

PKIdentityError

struct · iOS 16.0+

PKIdentityError.Code

enum · iOS 16.0+

PKIdentityIntentToStore

class · iOS 16.0+

PKIdentityNationalIDCardDescriptor

class · iOS 18.0+

PKIdentityPhotoIDDescriptor

class · iOS 26.0+

PKIdentityRequest

class · iOS 16.0+

PKInformationRequestCompletionBlock

typealias

PKInstantFundsOutFeeSummaryItem

class · iOS 17.0+

PKIssuerProvisioningExtensionAuthorizationProviding

protocol · iOS 14.0+

PKIssuerProvisioningExtensionAuthorizationResult

enum · iOS 14.0+

PKIssuerProvisioningExtensionHandler

class · iOS 14.0+

PKIssuerProvisioningExtensionPassEntry

class · iOS 14.0+

PKIssuerProvisioningExtensionPaymentPassEntry

class · iOS 14.0+

PKIssuerProvisioningExtensionStatus

class · iOS 14.0+

PKJapanIndividualNumberCardMetadata

class · iOS 18.0+

PKLabeledValue

class · iOS 10.1+

PKMerchantCapability

struct · iOS 8.0+

PKObject

class

PKPass

class

PKPassKitError

struct · iOS 6.0+

PKPassKitError.Code

enum · iOS 6.0+

PKPassLibrary

class · iOS 6.0+

PKPassLibrary.AuthorizationStatus

enum · iOS 26.0+

PKPassLibrary.Capability

enum · iOS 26.0+

PKPassLibraryAddPassesStatus

enum · iOS 7.0+

PKPassLibraryNotificationKey

struct

PKPassLibraryNotificationName

struct

PKPassRelevantDate

class

PKPassType

enum · iOS 8.0+

PKPayLater

enum · iOS 17.0+

PKPayLaterAction

enum · iOS 17.0+

PKPayLaterDisplayStyle

enum · iOS 17.0+

PKPayLaterView

class · iOS 17.0+

PKPayLaterViewDelegate

protocol · iOS 17.0+

PKPayment

class · iOS 8.0+

PKPaymentAuthorizationController

class · iOS 10.0+

PKPaymentAuthorizationControllerDelegate

protocol

PKPaymentAuthorizationResult

class · iOS 11.0+

PKPaymentAuthorizationStatus

enum · iOS 8.0+

PKPaymentAuthorizationViewController

class · iOS 8.0+

PKPaymentAuthorizationViewControllerDelegate

protocol

PKPaymentButton

class · iOS 8.3+

PKPaymentButtonStyle

enum · iOS 8.3+

PKPaymentButtonType

enum · iOS 8.3+

PKPaymentError

struct · iOS 11.0+

PKPaymentError.Code

enum · iOS 11.0+

PKPaymentErrorKey

struct

PKPaymentInformationEventExtension

class · iOS 14.0+

PKPaymentInformationRequestHandling

protocol

PKPaymentMerchantSession

class · iOS 14.0+

PKPaymentMethod

class · iOS 9.0+

PKPaymentMethodType

enum · iOS 9.0+

PKPaymentNetwork

struct

PKPaymentOrderDetails

class · iOS 16.0+

PKPaymentPass

class · iOS 8.0+

PKPaymentPassActivationState

enum · iOS 8.0+ · Deprecated in iOS 100000.0

PKPaymentRequest

class · iOS 8.0+

PKPaymentRequest.ApplePayLaterAvailability

enum · iOS 17.0+

PKPaymentRequest.ApplePayLaterAvailability.Reason

enum · iOS 17.0+

PKPaymentRequest.MerchantCategoryCode

struct · iOS 18.0+

PKPaymentRequest.MerchantCategoryCode.RawValue

typealias · iOS 18.0+

PKPaymentRequestCouponCodeUpdate

class · iOS 15.0+

PKPaymentRequestMerchantSessionUpdate

class · iOS 14.0+

PKPaymentRequestPaymentMethodUpdate

class · iOS 11.0+

PKPaymentRequestShippingContactUpdate

class · iOS 11.0+

PKPaymentRequestShippingMethodUpdate

class · iOS 11.0+

PKPaymentRequestUpdate

class · iOS 11.0+

PKPaymentSummaryItem

class · iOS 8.0+

PKPaymentSummaryItemType

enum · iOS 9.0+

PKPaymentToken

class · iOS 8.0+

PKPaymentTokenContext

class · iOS 16.0+

PKRadioTechnology

struct · iOS 14.5+

PKRecurringPaymentRequest

class · iOS 16.0+

PKRecurringPaymentSummaryItem

class · iOS 15.0+

PKSecureElementPass

class · iOS 13.4+

PKSecureElementPass.PassActivationState

enum · iOS 13.4+

PKShareablePassMetadata

class · iOS 14.0+

PKShareablePassMetadata.Preview

class · iOS 16.0+

PKShareSecureElementPassError

struct · iOS 16.0+

PKShareSecureElementPassError.Code

enum · iOS 16.0+

PKShareSecureElementPassResult

enum · iOS 16.0+

PKShareSecureElementPassViewController

class · iOS 16.0+

PKShareSecureElementPassViewControllerDelegate

protocol · iOS 16.0+

PKShippingContactEditingMode

enum · iOS 15.0+

PKShippingMethod

class · iOS 8.0+

PKShippingType

enum · iOS 8.3+

PKSignatureRequestCompletionBlock

typealias

PKStoredValuePassBalance

class · iOS 15.0+

PKStoredValuePassBalance.BalanceType

struct

PKStoredValuePassProperties

class · iOS 15.0+

PKSuicaPassProperties

class · iOS 10.1+

PKSuppressionRequestToken

typealias

PKTransitPassProperties

class · iOS 11.3+

PKVehicleConnectionDelegate

protocol · iOS 15.4+

PKVehicleConnectionErrorCode

enum · iOS 15.4+

PKVehicleConnectionSession

class · iOS 15.4+

PKVehicleConnectionSessionConnectionState

enum · iOS 15.4+

Functions and constants

get · iOS 13.4+

PKAddSecureElementPassErrorDomain

TypeScript

const PKAddSecureElementPassErrorDomain: string

Swift declaration

let PKAddSecureElementPassErrorDomain: String

get · iOS 17.0+

PKDisbursementErrorDomain

TypeScript

const PKDisbursementErrorDomain: string

Swift declaration

let PKDisbursementErrorDomain: String

get · iOS 16.0+

PKIdentityErrorDomain

TypeScript

const PKIdentityErrorDomain: string

Swift declaration

let PKIdentityErrorDomain: String

get · iOS 6.0+

PKPassKitErrorDomain

TypeScript

const PKPassKitErrorDomain: string

Swift declaration

let PKPassKitErrorDomain: String

get · iOS 11.0+

PKPaymentErrorDomain

TypeScript

const PKPaymentErrorDomain: string

Swift declaration

let PKPaymentErrorDomain: String

get · iOS 16.0+

PKShareSecureElementPassErrorDomain

TypeScript

const PKShareSecureElementPassErrorDomain: string

Swift declaration

let PKShareSecureElementPassErrorDomain: String

get · iOS 18.0+

data

TypeScript

get data(): ArrayBuffer

Swift declaration

let data: Data

Certificate data will be formatted as X.509 DER

init · iOS 18.0+

init

TypeScript

static initType(type: JPKIPassContents_UserIdentity_AuthenticationType): JPKIPassContents_AuthenticationRequest<JPKIPassContents_UserIdentity>

Swift declaration

init(type: JPKIPassContents.UserIdentity.AuthenticationType)

init · iOS 18.0+

init

TypeScript

static initType21560(type: JPKIPassContents_SigningIdentity_AuthenticationType): JPKIPassContents_AuthenticationRequest<JPKIPassContents_SigningIdentity>

Swift declaration

init(type: JPKIPassContents.SigningIdentity.AuthenticationType)

get · iOS 18.0+

certificate

TypeScript

get certificate(): JPKIPassContents_Certificate<SDKHandle>

Swift declaration

let certificate: JPKIPassContents.Certificate<IdentityType>

get · iOS 18.0+

signatureData

TypeScript

get signatureData(): ArrayBuffer

Swift declaration

let signatureData: Data

Signature data format is determined by the pass

Skipped declarations

77 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

PKAddPassMetadataPreview.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKAddSecureElementPassConfiguration.init()

inherited init: clang: 'init' is unavailable

PKAddPassesViewController.init()

inherited init: cannot prove legal (class declares 7 custom initializers)

PKBarcodeEventMetadataResponse.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKBarcodeEventSignatureResponse.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKDisbursementRequest.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKAddPaymentPassViewController.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKDateComponentsRange.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

PKPayLaterView.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKAddSecureElementPassViewController.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKPaymentSummaryItem.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

PKAddPassButton.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKPass.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKSuicaPassProperties.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKPaymentAuthorizationViewController.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

PKIdentityButton.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKIssuerProvisioningExtensionPaymentPassEntry.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKIssuerProvisioningExtensionPassEntry.init()

inherited init: clang: 'init' is unavailable

PKStoredValuePassBalance.init()

inherited init: clang: 'init' is unavailable

PKPaymentButton.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

PKLabeledValue.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKPaymentTokenContext.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKShareSecureElementPassViewController.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKRecurringPaymentRequest.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKPaymentAuthorizationController.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

PKPassRelevantDate.init()

inherited init: clang: 'init' is unavailable

PKAddShareablePassConfiguration.init()

inherited init: clang: 'init' is unavailable

PKShareablePassMetadata.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

PKShareablePassMetadata.Preview.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

PKAutomaticReloadPaymentRequest.init()

inherited init: cannot prove legal (class declares 1 custom initializer)