PassKit Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The PassKit namespace provides classes for creating and manipulating passes, including payment and authorization passes.

Classes

Name	Description
PKAddCarKeyPassConfiguration
PKAddIdentityDocumentConfiguration
PKAddIdentityDocumentMetadata
PKAddPassButton	A button that adds passes to a Wallet.
PKAddPassButton.PKAddPassButtonAppearance	Appearance class for objects of type PKAddPassButton.
PKAddPassesViewController	A UIViewController that manages the user experience of viewing a PKPass and prompting the user to add it to the PKPassLibrary.
PKAddPassesViewControllerDelegate	A delegate object that gives the application developer fine-grained control over life-cycle events of a PKAddPassesViewController object.
PKAddPassesViewControllerDelegate_Extensions	Extension methods to the IPKAddPassesViewControllerDelegate interface to support all the methods from the PKAddPassesViewControllerDelegate protocol.
PKAddPassMetadataPreview
PKAddPaymentPassRequest	Used to hold card data being inserted into Apple Pay.
PKAddPaymentPassRequestConfiguration	Holds configuration data needed by a PKAddPaymentPassViewController.
PKAddPaymentPassViewController	A standard UIViewController for adding cards to Apple Pay.
PKAddPaymentPassViewControllerDelegate	Delegate object for PKAddPaymentPassViewController whose members are called when prompting for an add payment request and when an PKAddPaymentPassRequest has failed.
PKAddSecureElementPassConfiguration
PKAddSecureElementPassErrorCodeExtensions	Extension methods for the PKAddSecureElementPassErrorCode enumeration.
PKAddSecureElementPassViewController
PKAddSecureElementPassViewControllerDelegate	This is a class that implements the interface IPKAddSecureElementPassViewControllerDelegate (for the protocol `PKAddSecureElementPassViewControllerDelegate`). Subclass this class to easily create a type that implements the protocol. An alternative is to create a subclass of NSObject and then implemented the interface IPKAddSecureElementPassViewControllerDelegate.
PKAddShareablePassConfiguration
PKAutomaticReloadPaymentRequest
PKAutomaticReloadPaymentSummaryItem
PKBarcodeEventConfigurationRequest
PKBarcodeEventMetadataRequest
PKBarcodeEventMetadataResponse
PKBarcodeEventSignatureRequest
PKBarcodeEventSignatureResponse
PKContact	Shipping and billing information for a single Apple Pay transaction.
PKContactFieldsExtensions	Extension methods for the PKContactFields enumeration.
PKDateComponentsRange
PKDeferredPaymentRequest
PKDeferredPaymentSummaryItem
PKDirbursementError
PKDisbursementAuthorizationController
PKDisbursementAuthorizationControllerDelegate
PKDisbursementErrorCodeExtensions	Extension methods for the PKDisbursementErrorCode enumeration.
PKDisbursementRequest
PKDisbursementSummaryItem
PKDisbursementVoucher
PKEncryptionScheme	Defines the constant string Ecc_V2.
PKIdentityAnyOfDescriptor
PKIdentityAuthorizationController
PKIdentityButton
PKIdentityButton.PKIdentityButtonAppearance	Appearance class for objects of type PKIdentityButton.
PKIdentityDocument
PKIdentityDocumentMetadata
PKIdentityDriversLicenseDescriptor
PKIdentityElement
PKIdentityErrorExtensions	Extension methods for the PKIdentityError enumeration.
PKIdentityIntentToStore
PKIdentityNationalIdCardDescriptor
PKIdentityPhotoIdDescriptor
PKIdentityRequest
PKInstantFundsOutFeeSummaryItem
PKIssuerProvisioningExtensionHandler
PKIssuerProvisioningExtensionPassEntry
PKIssuerProvisioningExtensionPaymentPassEntry
PKIssuerProvisioningExtensionStatus
PKJapanIndividualNumberCardMetadata
PKLabeledValue	A labeled value for card details.
PKObject	Base class for PKPass. Defines copy and encoding methods.
PKPass	A pass, which is an abstraction of such things as tickets, boarding passes, or gift or loyalty cards.
PKPassKitErrorCodeExtensions	Extension methods for the PKPassKitErrorCode enumeration.
PKPassLibrary	Represents the user's library of passes.
PKPassLibrary.Notifications	Notifications posted by the PKPassLibrary class.
PKPassLibraryUserInfoKey	A class whose static members represent keys to be used with the GetLocalizedValue(NSString) method.
PKPassRelevantDate
PKPayLaterView
PKPayLaterView.PKPayLaterViewAppearance	Appearance class for objects of type PKPayLaterView.
PKPayLaterViewDelegate	This is a class that implements the interface IPKPayLaterViewDelegate (for the protocol `PKPayLaterViewDelegate`). Subclass this class to easily create a type that implements the protocol. An alternative is to create a subclass of NSObject and then implemented the interface IPKPayLaterViewDelegate.
PKPayment	The result of an authorized payment request. Contains encrypted payment information.
PKPaymentAuthorizationController	Presents a payment authorization user interface to the user and acts on the user's response.
PKPaymentAuthorizationControllerDelegate	Delegate object that responds to user interactions on behalf of a PKPaymentAuthorizationController.
PKPaymentAuthorizationControllerDelegate_Extensions	Extension methods to the IPKPaymentAuthorizationControllerDelegate interface to support all the methods from the PKPaymentAuthorizationControllerDelegate protocol.
PKPaymentAuthorizationEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentAuthorizationResult
PKPaymentAuthorizationResultEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentAuthorizationViewController	Standard view controller that prompts the user to authorize a payment.
PKPaymentAuthorizationViewControllerDelegate	Delegate object providing events relating to a payment authorization request made with a PKPaymentAuthorizationViewController.
PKPaymentAuthorizationViewControllerDelegate_Extensions	Extension methods to the IPKPaymentAuthorizationViewControllerDelegate interface to support all the methods from the PKPaymentAuthorizationViewControllerDelegate protocol.
PKPaymentButton	A button used to activate an Apple Pay payment. Available styles and types are defined by PKPaymentButtonStyle and PKPaymentButtonType.
PKPaymentButton.PKPaymentButtonAppearance	Appearance class for objects of type PKPaymentButton.
PKPaymentErrorCodeExtensions	Extension methods for the PKPaymentErrorCode enumeration.
PKPaymentErrorKeys	Enumerates fields that caused payment errors.
PKPaymentInformationEventExtension
PKPaymentMerchantSession
PKPaymentMethod	Information about Apple Pay cards.
PKPaymentMethodSelectedEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentNetwork	Standard values returned by PaymentNetwork.
PKPaymentOrderDetails
PKPaymentPass	A provisioned payment card that may be used for in-app purchases. (All fields are read-only)
PKPaymentRequest	The main class for a payment request, including processing capabilities, amount request, and shipping information.
PKPaymentRequestCouponCodeUpdate
PKPaymentRequestCouponCodeUpdateEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentRequestMerchantSessionUpdate
PKPaymentRequestMerchantSessionUpdateEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentRequestPaymentMethodUpdate
PKPaymentRequestPaymentMethodUpdateEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentRequestShippingContactUpdate
PKPaymentRequestShippingContactUpdateEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentRequestShippingMethodUpdate
PKPaymentRequestShippingMethodUpdateEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentRequestUpdate
PKPaymentSelectedContactEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentShippingAddressSelectedEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentShippingMethodSelectedEventArgs	Provides data for an event based on an Objective-C protocol method.
PKPaymentSummaryItem	A summary item (such as grand total, tax, or discounts) within a payment request.
PKPaymentToken	The user's payment credentials. All fields are read-only.
PKPaymentTokenContext
PKRecurringPaymentRequest
PKRecurringPaymentSummaryItem
PKSecureElementPass
PKServiceProviderDataCompletionResult	This class holds the return values for an asynchronous operation.
PKShareablePassMetadata
PKShareablePassMetadataPreview
PKShareSecureElementPassErrorCodeExtensions	Extension methods for the PKShareSecureElementPassErrorCode enumeration.
PKShareSecureElementPassViewController
PKShareSecureElementPassViewControllerDelegate	This is a class that implements the interface IPKShareSecureElementPassViewControllerDelegate (for the protocol `PKShareSecureElementPassViewControllerDelegate`). Subclass this class to easily create a type that implements the protocol. An alternative is to create a subclass of NSObject and then implemented the interface IPKShareSecureElementPassViewControllerDelegate.
PKShareSecureElementPassViewControllerDelegate_Extensions	Extension methods to the IPKShareSecureElementPassViewControllerDelegate interface to support all the methods from the PKShareSecureElementPassViewControllerDelegate protocol.
PKShippingMethod	A shipping method for physical goods.
PKSignDataCompletionResult	This class holds the return values for an asynchronous operation.
PKStoredValuePassBalance
PKStoredValuePassBalanceTypeExtensions	Extension methods for the PKStoredValuePassBalanceType enumeration.
PKStoredValuePassProperties
PKSuicaPassProperties	Contains Suica pass properties.
PKTransitPassProperties
PKVehicleConnectionDelegate	This is a class that implements the interface IPKVehicleConnectionDelegate (for the protocol `PKVehicleConnectionDelegate`). Subclass this class to easily create a type that implements the protocol. An alternative is to create a subclass of NSObject and then implemented the interface IPKVehicleConnectionDelegate.
PKVehicleConnectionSession

Structs

Name	Description
PKMerchantCategoryCode	The four-digit type, in ISO 18245 format, that represents the type of goods or service a merchant provides for a transaction.

Interfaces

Name	Description
IPKAddPassesViewControllerDelegate	A delegate object that gives the application developer fine-grained control over life-cycle events of a PKAddPassesViewController object.
IPKAddPaymentPassViewControllerDelegate	Delegate object for PKAddPaymentPassViewController whose members are called when prompting for an add payment request and when an PKAddPaymentPassRequest has failed.
IPKAddSecureElementPassViewControllerDelegate	This interface represents the Objective-C protocol `PKAddSecureElementPassViewControllerDelegate`.
IPKDisbursementAuthorizationControllerDelegate
IPKIdentityDocumentDescriptor	This interface represents the Objective-C protocol `PKIdentityDocumentDescriptor`.
IPKIssuerProvisioningExtensionAuthorizationProviding	This interface represents the Objective-C protocol `PKIssuerProvisioningExtensionAuthorizationProviding`.
IPKPayLaterViewDelegate	This interface represents the Objective-C protocol `PKPayLaterViewDelegate`.
IPKPaymentAuthorizationControllerDelegate	Delegate object that responds to user interactions on behalf of a PKPaymentAuthorizationController.
IPKPaymentAuthorizationViewControllerDelegate	Delegate object providing events relating to a payment authorization request made with a PKPaymentAuthorizationViewController.
IPKPaymentInformationRequestHandling	This interface represents the Objective-C protocol `PKPaymentInformationRequestHandling`.
IPKShareSecureElementPassViewControllerDelegate	This interface represents the Objective-C protocol `PKShareSecureElementPassViewControllerDelegate`.
IPKVehicleConnectionDelegate	This interface represents the Objective-C protocol `PKVehicleConnectionDelegate`.

Enums

Name	Description
PKAddIdentityDocumentType
PKAddPassButtonStyle	Enumerates Pass Button styles.
PKAddPaymentPassError	Enumerates error codes relating to PassKit operations.
PKAddPaymentPassStyle
PKAddressField	Holds address information for billing or shipping purposes.
PKAddSecureElementPassErrorCode
PKAddShareablePassConfigurationPrimaryAction
PKApplePayLaterAvailability
PKAutomaticPassPresentationSuppressionResult	Enumerates results that are used in calls to RequestAutomaticPassPresentationSuppression(Action<PKAutomaticPassPresentationSuppressionResult>).
PKBarcodeEventConfigurationDataType
PKContactFields	Enumerates fields for a contact.
PKDisbursementErrorCode
PKDisbursementRequestSchedule
PKIdentityButtonLabel
PKIdentityButtonStyle
PKIdentityError
PKIssuerProvisioningExtensionAuthorizationResult
PKJapanIndividualNumberCardMetadataConstructorOption	This enum is used to select how to initialize a new instance of a PKJapanIndividualNumberCardMetadata.
PKMerchantCapability	Payment processing capabilities of a merchant.
PKPassKitErrorCode	An enumeration whose values specify errors relating to the passes and passbook functionality.
PKPassLibraryAddPassesStatus	An enumeration whose values define possible results when passes are added.
PKPassLibraryAuthorizationStatus
PKPassLibraryCapability
PKPassType	Enumeration of pass types (whether a pass is a barcode or presents a payment card).
PKPayLaterAction
PKPayLaterDisplayStyle
PKPaymentAuthorizationStatus	Enumeration of results of authorization requests.
PKPaymentButtonStyle	Enumerates available styles for PKPaymentButton objects.
PKPaymentButtonType	Enumerates the types of PKPaymentButton objects.
PKPaymentErrorCode	Enumerates error conditions for payment operations.
PKPaymentMethodType	Enumerates the types of cards available to Apple Pay.
PKPaymentPassActivationState	Enumeration of valid states of a PKPaymentPass payment card.
PKPaymentSummaryItemType	Enumerates whether a payment associated with a PKShippingMethod is pending or final.
PKRadioTechnology
PKSecureElementPassActivationState
PKShareablePassMetadata.CardType	This enum describes how to interpret some arguments when creating PKShareablePassMetadata instances.
PKShareSecureElementPassErrorCode
PKShareSecureElementPassResult
PKShippingContactEditingMode
PKShippingType	Enumerates shipping methods.
PKStoredValuePassBalanceType
PKVehicleConnectionErrorCode
PKVehicleConnectionSessionConnectionState

Delegates

Name	Description
PKAddIdentityDocumentConfigurationGetConfigurationCompletionHandler
PKInformationRequestCompletionBlock
PKPassLibrarySignDataCompletionHandler
PKPayLaterViewValidateAmountCallback	The delegate that is called when ValidateAmount(Decimal, String, PKPayLaterViewValidateAmountCallback) has determined whether the Pay Later Merchandising information is valid.
PKPaymentShippingAddressSelected	Delegate called when the user has selected a shipping address.
PKPaymentShippingMethodSelected	Delegate called when the user has selected a shipping method.
PKSignatureRequestCompletionBlock