Framework

Pass​Kit

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

PKAdd​Pass​Button

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

PKAdd​Passes​View​Controller

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

PKAdd​Payment​Pass​Request

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

PKAdd​Payment​Pass​Request​Configuration

Contains the configuration data needed to instantiate a new PKAdd​Payment​Pass​View​Controller object.

PKAdd​Payment​Pass​View​Controller

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.

PKLabeled​Value

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.

PKPass​Library

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.

PKPayment​Authorization​Controller

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

PKPayment​Authorization​View​Controller

Prompts the user to authorize a payment request.

PKPayment​Button

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

PKPayment​Method

Contains information about Apple Pay cards.

PKPayment​Pass

Represents a provisioned payment card for in-app payments.

PKPayment​Request

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

PKPayment​Summary​Item

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

PKPayment​Token

Contains the user’s payment credentials.

PKShipping​Method

Defines a shipping method for delivering physical goods.

PKSuica​Pass​Properties

Represents the properties a Suica pass can have.

Protocols

PKAdd​Passes​View​Controller​Delegate

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

PKAdd​Payment​Pass​View​Controller​Delegate

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

PKPayment​Authorization​Controller​Delegate

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

PKPayment​Authorization​View​Controller​Delegate

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

Structures

PKAddress​Field

Billing or shipping address fields.

PKEncryption​Scheme

Encryption schemes.

PKMerchant​Capability

Capabilities for processing payment.

PKPass​Kit​Error

Errors used by the PassKit framework.

PKPass​Library​Notification​Name

Types of notifications issued by a pass library instance.

PKPayment​Network

Payment networks.

Extended Types

PKPass​Kit​Error

Errors used by the PassKit framework.