Class

PKSuicaPassProperties

The properties of a Suica pass.

Declaration

class PKSuicaPassProperties : PKTransitPassProperties

Overview

The Suica pass is a card used for transportation in Japan.

Topics

Initializing Suica Pass Properties

init?(for: PKPass)

Instantiates a Suica pass properties object that contains the properties supported in the specified pass.

Getting Pass Status

var isBlacklisted: Bool

A Boolean value that indicates whether the transit pass issuer disabled the pass.

var isGreenCarTicketUsed: Bool

A Boolean value that indicates whether the customer has redeemed the Green Car ticket.

var isInShinkansenStation: Bool

A Boolean value that indicates whether the pass has tapped in at a Shinkansen Station and has not tapped out.

var isInStation: Bool

A Boolean value that indicates whether the transit pass has tapped in at a station and has not tapped out.

Getting Suica Balance Information

var transitBalance: NSDecimalNumber

The current usable stored value on the transit card.

var transitBalanceCurrencyCode: String

The currency code associated with the balance on the pass.

var isBalanceAllowedForCommute: Bool

A Boolean value that indicates how the balance can be used.

var isLowBalanceGateNotificationEnabled: Bool

A Boolean value that determines whether the terminal provides feedback if the balance is low after a deduction.

Relationships

Conforms To

See Also

Passes

class PKPass

An object that represents a single pass.

class PKPassLibrary

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

class PKTransitPassProperties

The properties of a transit pass.

class 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.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software