iOS Developer Library — Prerelease

Developer

PassKit Framework Reference

Introduction

Classes   Protocols   Other Reference  

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

The Passbook app allows users to organize their boarding passes, tickets, gift cards, and loyalty cards. Using the PassKit framework, you can add passes to Passbook 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, Passbook 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.

Classes

NSObject

NSObject is the root class of most Objective-C class hierarchies.

PKAddPaymentPassRequest

The PKAddPaymentPassRequest class contains the card data needed to add a card to Apple Pay.

PKAddPaymentPassRequestConfiguration

The PKAddPaymentPassRequestConfiguration class contains the configuration data needed to instantiate a new PKAddPaymentPassViewController object.

PKContact

PKObject

The PKObject class is an opaque type that acts as the superclass for the PKPass class.

PKPass

The PKPass class represents a single pass.

PKPaymentPass

The PKPaymentPass class represents a provisioned payment card for in-app payments.

PKPassLibrary

The PKPassLibrary class provides an interface to the user’s library of passes.

PKPayment

The PKPayment class represents the result of authorizing a payment request.

PKPaymentMethod

PKPaymentMethod objects contains information about Apple Pay cards.

PKPaymentRequest

The PKPaymentRequest class encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information.

PKPaymentSummaryItem

The PKPaymentSummaryItem class defines a summary item in a payment request—for example, total, tax, discount, or grand total.

PKShippingMethod

The PKShippingMethod defines a shipping method for delivering physical goods.

PKPaymentToken

The PKPaymentToken class contains the user’s payment credentials.

UIButton

An instance of the UIButton class implements a button on the touch screen.

PKPaymentButton

The PKPaymentButton class provides a button that is used to trigger payments through Apple Pay.

UIViewController

The UIViewController class provides the infrastructure for managing the views of your iOS apps.

PKAddPassesViewController

The PKAddPassesViewController class lets your app show a pass and prompt the user to add that pass to the pass library.

PKAddPaymentPassViewController

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

PKPaymentAuthorizationViewController

The PKPaymentAuthorizationViewController class prompts the user to authorize a payment request.

Protocols

PKAddPassesViewControllerDelegate

The PKAddPassesViewControllerDelegate protocol defines methods that an add-passes view controller’s delegate implements.

PKAddPaymentPassViewControllerDelegate

Delegates for the PKAddPaymentPassViewController class must adopt this protocol.

PKPaymentAuthorizationViewControllerDelegate

The PKPaymentAuthorizationViewControllerDelegate protocol is implemented by the payment authorization view controller’s delegate.

Other Reference

Passbook Package Format Reference

Payment Token Format Reference