<!--
{
  "availability" : [
    "iOS: 15.4.0 -",
    "iPadOS: 15.4.0 -",
    "macCatalyst: 17.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "ProximityReader",
  "identifier" : "/documentation/ProximityReader/PaymentCardReader",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "ProximityReader"
    ],
    "preciseIdentifier" : "s:15ProximityReader011PaymentCardB0C"
  },
  "title" : "PaymentCardReader"
}
-->

# PaymentCardReader

An object you use to configure Tap to Pay on iPhone on the current device.

```
class PaymentCardReader
```

## Overview

A `PaymentCardReader` object coordinates the reading of payment and loyalty
cards using existing iPhone hardware. Use it to read cards that
might otherwise require specialized hardware. For example, use it to collect
contactless payment information from another iPhone or from NFC-enabled hardware,
such as NFC-enabled plastic cards.

After you create the `PaymentCardReader` object, call [`prepare(using:)`](/documentation/ProximityReader/PaymentCardReader/prepare(using:))
to validate the payment pipeline and receive a new [`PaymentCardReaderSession`](/documentation/ProximityReader/PaymentCardReaderSession).
Use the session object to read card information related to payments and refunds,
or to verify card information.

## Topics

### Creating a payment reader

[`init(options:)`](/documentation/ProximityReader/PaymentCardReader/init(options:))

Creates a payment card reader with the specified options.

[`PaymentCardReader.Options`](/documentation/ProximityReader/PaymentCardReader/Options-swift.struct)

Additional information you use to configure a payment card reader.

### Getting the feature availability

[`isSupported`](/documentation/ProximityReader/PaymentCardReader/isSupported)

A Boolean value that indicates whether this device model supports Tap to Pay on iPhone.

### Configuring Tap to Pay on iPhone

[`prepare(using:)`](/documentation/ProximityReader/PaymentCardReader/prepare(using:))

Configures the pipeline for reading payment or loyalty cards.

### Displaying the Tap to Pay on iPhone’s terms and conditions

[`isAccountLinked(using:)`](/documentation/ProximityReader/PaymentCardReader/isAccountLinked(using:))

A Boolean value that indicates whether the account is already linked.

[`linkAccount(using:)`](/documentation/ProximityReader/PaymentCardReader/linkAccount(using:))

Presents a sheet for the merchant to accept Tap to Pay on iPhone’s Terms and Conditions on a device.

[`relinkAccount(using:)`](/documentation/ProximityReader/PaymentCardReader/relinkAccount(using:))

Presents a sheet for the merchant to re-accept Tap to Pay on iPhone’s Terms and Conditions on a device using a different Apple Account.

[`PaymentCardReader.Token`](/documentation/ProximityReader/PaymentCardReader/Token)

A secure token that you receive from your participating payment service provider.

### Observing reader events

[`events`](/documentation/ProximityReader/PaymentCardReader/events)

A stream of events you receive indicating the activities of the payment card reader.

[`PaymentCardReader.Event`](/documentation/ProximityReader/PaymentCardReader/Event)

An event you receive indicating the state or activity of the payment card reader.

### Getting the configuration details

[`readerIdentifier`](/documentation/ProximityReader/PaymentCardReader/readerIdentifier)

The unique identifier for this card reader.

[`options`](/documentation/ProximityReader/PaymentCardReader/options-swift.property)

The defined configuration settings when the reader was created.

### Deprecated

[`id`](/documentation/ProximityReader/PaymentCardReader/id)

A unique identifier for this object.

[`prepare(using:updateHandler:)`](/documentation/ProximityReader/PaymentCardReader/prepare(using:updateHandler:))

Configures the pipeline for reading payment or loyalty cards.

[`PaymentCardReader.UpdateEvent`](/documentation/ProximityReader/PaymentCardReader/UpdateEvent)

An event you receive during the configuration of the payment system.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)