Framework

PassKit

Create, distribute, and update passes for the Wallet app. Request and process Apple Pay payments in your app.

Overview

The PassKit framework lets you add and manage passes in the user’s Wallet app.

The Wallet app allows users to organize their boarding passes, tickets, gift cards, and loyalty cards. Using the PassKit framework, you can add passes to Wallet and have these passes appear on the user’s lock screen based on the time and place when the pass is relevant. You can also update a pass’s content using push notifications.

Additionally, Wallet manages the user’s credit cards for Apple Pay. The PassKit framework also supports in-app payments for physical goods and services using Apple Pay. For digital goods and services delivered within the app, see In-App Purchase Programming Guide instead.

Symbols

Classes

PKAddPassButton

Provides a button that is used to add passes to Wallet.

PKAddPassesViewController

Lets your app show a pass and prompt the user to add that pass to the pass library.

PKAddPaymentPassRequest

Contains the card data needed to add a card to Apple Pay.

PKAddPaymentPassRequestConfiguration

Contains the configuration data needed to instantiate a new PKAddPaymentPassViewController object.

PKAddPaymentPassViewController

Lets you display an interface that lets users add cards to Apple Pay from within your app.

PKContact

Encapsulates contact information needed for billing and shipping.

PKLabeledValue

An object that can represent a detail about a payment card or other item.

PKObject

An opaque type that acts as the superclass for the PKPass class.

PKPass

An object that represents a single pass.

PKPassLibrary

Provides an interface to the user’s library of passes.

PKPayment

Represents the result of authorizing a payment request and contains payment information, encrypted in the payment token.

PKPaymentAuthorizationController

Presents a sheet that prompts the user to authorize a payment request.

PKPaymentAuthorizationViewController

Prompts the user to authorize a payment request.

PKPaymentButton

Provides a button that is used either to trigger payments through Apple Pay or to prompt the user to set up a card.

PKPaymentMethod

Contains information about Apple Pay cards.

PKPaymentPass

Represents a provisioned payment card for in-app payments.

PKPaymentRequest

Encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information.

PKPaymentSummaryItem

Defines a summary item in a payment request—for example, total, tax, discount, or grand total.

PKPaymentToken

Contains the user’s payment credentials.

PKShippingMethod

Defines a shipping method for delivering physical goods.

PKSuicaPassProperties

Represents the properties a Suica pass can have.

Protocols

PKAddPassesViewControllerDelegate

Methods that an add-passes view controller’s delegate implements.

PKAddPaymentPassViewControllerDelegate

Methods that let the system prompt you for an add payment request, and inform you when a request has succeeded or failed.

PKPaymentAuthorizationControllerDelegate

Methods that let you respond to user interactions with your payment authorization controller.

PKPaymentAuthorizationViewControllerDelegate

Methods that let you respond to user interactions with your payment authorization view controller.

Structures

PKAddressField

Billing or shipping address fields.

PKEncryptionScheme

Encryption schemes.

PKMerchantCapability

Capabilities for processing payment.

PKPassKitError

Errors used by the PassKit framework.

PKPassLibraryNotificationKey

Keys in the PKPassLibraryDidChange user info dictionary.

PKPassLibraryNotificationName

Types of notifications issued by a pass library instance.

PKPaymentNetwork

Payment networks.

Extended Types

PKPassKitError

Errors used by the PassKit framework.