Class

PKSuicaPassProperties

The properties of a Suica pass.

Declaration

@interface PKSuicaPassProperties : PKTransitPassProperties

Overview

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

Topics

Initializing Suica Pass Properties

+ passPropertiesForPass:

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

Getting Pass Status

blacklisted

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

greenCarTicketUsed

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

inShinkansenStation

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

inStation

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

Getting Suica Balance Information

transitBalance

The current usable stored value on the transit card.

transitBalanceCurrencyCode

The currency code associated with the balance on the pass.

balanceAllowedForCommute

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

lowBalanceGateNotificationEnabled

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

Relationships

See Also

Passes

PKPass

An object that represents a single pass.

PKPassLibrary

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

PKTransitPassProperties

The properties of a transit 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.