<!--
{
  "availability" : [
    "iOS: 9.0.0 -",
    "iPadOS: 9.0.0 -",
    "macCatalyst: 13.1.0 -",
    "macOS: -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "PassKit",
  "identifier" : "/documentation/PassKit/PKAddPaymentPassRequestConfiguration",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "PassKit (Apple Pay and Wallet)"
    ],
    "preciseIdentifier" : "c:objc(cs)PKAddPaymentPassRequestConfiguration"
  },
  "title" : "PKAddPaymentPassRequestConfiguration"
}
-->

# PKAddPaymentPassRequestConfiguration

Contains the configuration data for a view controller that lets the user add a payment pass.

```
class PKAddPaymentPassRequestConfiguration
```

## Overview

The encryption scheme, cardholder name, and primary account suffix are required for configuration. The configuration information is used for setup and display only. It should not contain any sensitive information.

> Important:
> Adding payment passes requires a special entitlement issued by Apple. Your app must include this entitlement before you can use this class. For more information on requesting this entitlement, see the Card Issuers section at [developer.apple.com/apple-pay/](https://developer.apple.com/apple-pay/).

## Topics

### Creating a request configuration

[`init(encryptionScheme:)`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/init(encryptionScheme:))

Instantiates a new request configuration with the given encryption scheme.

[`PKEncryptionScheme`](/documentation/PassKit/PKEncryptionScheme)

Encryption schemes.

### Filtering pass libraries

[`paymentNetwork`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/paymentNetwork)

The payment network.

[`primaryAccountIdentifier`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/primaryAccountIdentifier)

A primary account identifier, used to filter out pass libraries.

[`requiresFelicaSecureElement`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/requiresFelicaSecureElement)

A Boolean value that indicates whether the payment pass requires the Felica Secure Element.

### Payment pass request properties

[`cardholderName`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/cardholderName)

The name of the person as shown on the card.

[`encryptionScheme`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/encryptionScheme)

The encryption scheme to be used in this request.

[`PKEncryptionScheme`](/documentation/PassKit/PKEncryptionScheme)

Encryption schemes.

[`localizedDescription`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/localizedDescription)

A short description of the card.

[`primaryAccountSuffix`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/primaryAccountSuffix)

The last four or five digits of the card’s number.

[`cardDetails`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/cardDetails)

An array of labeled values that describe a card.

[`PKLabeledValue`](/documentation/PassKit/PKLabeledValue)

An object that can represent a detail about a payment card or other item.

[`productIdentifiers`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/productIdentifiers)

[`style`](/documentation/PassKit/PKAddPaymentPassRequestConfiguration/style)

A value that indicates whether a pass is for access or for payment use.

[`PKAddPaymentPassStyle`](/documentation/PassKit/PKAddPaymentPassStyle)

The type of payment pass.


---

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)