<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ApplePayontheWeb",
  "identifier" : "/documentation/ApplePayontheWeb/ApplePayPaymentPass",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Apple Pay on the Web"
    ],
    "preciseIdentifier" : "struct/ApplePayPaymentPass"
  },
  "title" : "ApplePayPaymentPass"
}
-->

# ApplePayPaymentPass

A provisioned payment card for Apple Pay payments.

```
dictionary ApplePayPaymentPass {
	required DOMString primaryAccountIdentifier;
	required DOMString primaryAccountNumberSuffix;
	DOMString deviceAccountIdentifier;
	DOMString deviceAccountNumberSuffix;
	required ApplePayPaymentPassActivationState activationState;
};
```

## Overview

Payment pass information is populated only for cobranded or private label cards, for specially registered websites.

## Topics

### Account Identity

[`required DOMString primaryAccountIdentifier;`](/documentation/ApplePayontheWeb/ApplePayPaymentPass/primaryAccountIdentifier)

The unique identifier for the primary account number for the payment card.

[`required DOMString primaryAccountNumberSuffix;`](/documentation/ApplePayontheWeb/ApplePayPaymentPass/primaryAccountNumberSuffix)

A version of the primary account number suitable for display in your UI.

[`DOMString deviceAccountIdentifier;`](/documentation/ApplePayontheWeb/ApplePayPaymentPass/deviceAccountIdentifier)

The unique identifier for the device-specific account number.

[`DOMString deviceAccountNumberSuffix;`](/documentation/ApplePayontheWeb/ApplePayPaymentPass/deviceAccountNumberSuffix)

A version of the device account number suitable for display in your UI.

### Activation State

[`required ApplePayPaymentPassActivationState activationState;`](/documentation/ApplePayontheWeb/ApplePayPaymentPass/activationState)

The activation state of the pass.

[`enum ApplePayPaymentPassActivationState`](/documentation/ApplePayontheWeb/ApplePayPaymentPassActivationState)

Payment pass activation states.


---

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)