One Logo Pool Ball
ProximityReader · IOS API REFERENCE

PaymentCardReadResult

struct · iOS 15.4+ · SDK 27.1

struct PaymentCardReadResult

The result of a payment card read operation. The system returns a `PaymentCardReadResult` in response to your requests to read a person's payment card. Use this information to facilitate payments with your payment service provider. For information about how to read a payment card, see ``PaymentCardReaderSession``.

Members (9)

get · iOS 15.4+

generalCardData

TypeScript
get generalCardData(): (string) | null
Swift declaration
let generalCardData: String?

A Base64-encoded string that contains general cardholder and terminal data in tag-length-value (TLV) format. The content of this field is determined by your payment service provider. This field can contain both card tags and terminal tags.

get · iOS 15.4+

paymentCardData

TypeScript
get paymentCardData(): (string) | null
Swift declaration
let paymentCardData: String?

A Base64-encoded string that contains the encrypted payment information to send to your payment provider. This information is present any time the system reads a card, including for purchases, refunds, and card verification.

get · iOS 17.0+

pinBypassed

TypeScript
get pinBypassed(): boolean
Swift declaration
let pinBypassed: Bool

A Boolean value that indicates whether the consumer bypassed the PIN entry. When the framework sets this property to `false`, the consumer didn't bypass the PIN entry or it wasn't required.

get · iOS 17.0+

isPINFallback

TypeScript
get isPINFallback(): boolean
Swift declaration
let isPINFallback: Bool

A Boolean value that indicates whether the PIN Fallback occurred. When the framework sets this property to `true`, the `paymentCardData` is a PIN Fallback read.

get · iOS 18.4+

cardEffectiveState

TypeScript
get cardEffectiveState(): (PaymentCardReadResult_CardEffectiveState) | null
Swift declaration
let cardEffectiveState: PaymentCardReadResult.CardEffectiveState?

The effective state of the card that the system read. This is only available in a Store and Forward session.

get · iOS 18.4+

cardExpirationState

TypeScript
get cardExpirationState(): (PaymentCardReadResult_CardExpirationState) | null
Swift declaration
let cardExpirationState: PaymentCardReadResult.CardExpirationState?

The expiration state of the card that the system read. This is only available in a Store and Forward session.

get · iOS 18.0+

applicationTypeIdentifier

TypeScript
get applicationTypeIdentifier(): (string) | null
Swift declaration
let applicationTypeIdentifier: String?

A string identifier that represents the payment application type (kernel) used to read the card.

get · iOS 15.4+

id

TypeScript
get id(): string
Swift declaration
let id: String

The unique identifier for the transaction. Include this identifier in support requests or tracing incidents to help track down potential problems.

get · iOS 16.4+

outcome

TypeScript
get outcome(): PaymentCardReadResult_ReadOutcome
Swift declaration
let outcome: PaymentCardReadResult.ReadOutcome

The outcome of the transaction. This field is meaningful only if you enable ``PaymentCardReader/Options/includeErrorInReadResult`` before you call ``PaymentCardReader/prepare(using:)``. If an error occurs while the ``PaymentCardReaderSession`` is open and the framework can retrieve ``paymentCardData``, ``PaymentCardReadResult`` includes both the ``PaymentCardReadResult/ReadOutcome`` and the other read data, otherwise the framework throws a ``PaymentCardReaderSession/ReadError``.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →