Class

PKPass

An object that represents a single pass.

Declaration

@interface PKPass : PKObject

Overview

The properties of this class correspond to fields of the pass. For details on what individual fields mean, see PassKit Package Format Reference.

Topics

Accessing the Pass in Wallet

passURL

The URL that opens the pass in the Wallet app.

Updating Passes

webServiceURL

The URL for your web service.

authenticationToken

The token used to authenticate update requests.

Identifying a Pass

passTypeIdentifier

The pass’s type identifier.

serialNumber

A value that uniquely identifies the pass.

passType

The pass’s type.

PKPassType

Types of passes.

paymentPass

For passes that represent payment cards, the underlying payment pass.

deviceName

The name of the device hosting the pass.

localizedName

The localized name for the pass’s template.

localizedDescription

The pass’s localized description.

remotePass

A Boolean value that indicates whether the pass is stored on a device that is paired with the current iOS device (for example, Apple Watch).

Displaying a Pass

icon

The pass icon.

organizationName

The name of the organization that created the pass.

- localizedValueForFieldKey:

Returns the localized value for specified field of the pass.

relevantDate

The date when the pass is most likely to be needed or useful.

Custom Information

userInfo

Developer-specific custom data.

Creating a Pass

- initWithData:error:

Initializes and returns an instance of the class.

Handling Errors

PKPassKitErrorDomain

Error domain for PassKit errors.

PKPassKitErrorCode

Errors used by the PassKit framework.

Relationships

Inherits From

See Also

Passes

PKPassLibrary

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

PKTransitPassProperties

The properties of a transit pass.

PKSuicaPassProperties

The properties of a Suica pass.

PKObject

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

Supporting Semantic Tags in Wallet Passes

Allow the system to offer Wallet passes to users intelligently by adding machine-readable metadata.