<!--
{
  "availability" : [
    "iOS: 16.1.0 -",
    "iPadOS: 16.1.0 -",
    "macCatalyst: 16.1.0 -",
    "macOS: 13.0.0 -",
    "tvOS: 16.1.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 9.1.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Matter",
  "identifier" : "/documentation/Matter/MTRSetupPayload",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Matter"
    ],
    "preciseIdentifier" : "c:objc(cs)MTRSetupPayload"
  },
  "title" : "MTRSetupPayload"
}
-->

# MTRSetupPayload

```
class MTRSetupPayload
```

## Topics

### Initializers

[`+  setupPayloadWithOnboardingPayload:error:`](/documentation/Matter/MTRSetupPayload/init(onboardingPayload:))

[`-  initWithPayload:`](/documentation/Matter/MTRSetupPayload/init(payload:))

[`-  initWithSetupPasscode:discriminator:`](/documentation/Matter/MTRSetupPayload/init(setupPasscode:discriminator:))

### Instance Properties

[`commissioningFlow`](/documentation/Matter/MTRSetupPayload/commissioningFlow)

[`discoveryCapabilities`](/documentation/Matter/MTRSetupPayload/discoveryCapabilities)

[`discriminator`](/documentation/Matter/MTRSetupPayload/discriminator)

[`hasShortDiscriminator`](/documentation/Matter/MTRSetupPayload/hasShortDiscriminator)

[`productID`](/documentation/Matter/MTRSetupPayload/productID)

[`rendezvousInformation`](/documentation/Matter/MTRSetupPayload/rendezvousInformation)

[`serialNumber`](/documentation/Matter/MTRSetupPayload/serialNumber)

[`setUpPINCode`](/documentation/Matter/MTRSetupPayload/setUpPINCode)

[`setupPasscode`](/documentation/Matter/MTRSetupPayload/setupPasscode)

[`vendorElements`](/documentation/Matter/MTRSetupPayload/vendorElements)

[`vendorID`](/documentation/Matter/MTRSetupPayload/vendorID)

[`version`](/documentation/Matter/MTRSetupPayload/version)

### Instance Methods

[`-  addOrReplaceVendorElement:`](/documentation/Matter/MTRSetupPayload/addOrReplaceVendorElement(_:))

[`-  getAllOptionalVendorData:`](/documentation/Matter/MTRSetupPayload/getAllOptionalVendorData())

[`-  manualEntryCode`](/documentation/Matter/MTRSetupPayload/manualEntryCode())

[`-  qrCodeString`](/documentation/Matter/MTRSetupPayload/qrCodeString())

[`-  qrCodeString:`](/documentation/Matter/MTRSetupPayload/qrCodeString(_:))

[`-  removeVendorElementWithTag:`](/documentation/Matter/MTRSetupPayload/removeVendorElement(withTag:))

[`-  vendorElementWithTag:`](/documentation/Matter/MTRSetupPayload/vendorElement(withTag:))

[`-  init`](/documentation/Matter/MTRSetupPayload/init)

### Type Methods

[`+  generateRandomPIN`](/documentation/Matter/MTRSetupPayload/generateRandomPIN())

[`+  generateRandomSetupPasscode`](/documentation/Matter/MTRSetupPayload/generateRandomSetupPasscode())

[`+  new`](/documentation/Matter/MTRSetupPayload/new())

## Relationships

### Conforms To

[`CVarArg`](/documentation/Swift/CVarArg)

[`NSCoding`](/documentation/Foundation/NSCoding)

[`Equatable`](/documentation/Swift/Equatable)

[`Hashable`](/documentation/Swift/Hashable)

[`NSCopying`](/documentation/Foundation/NSCopying)

[`NSSecureCoding`](/documentation/Foundation/NSSecureCoding)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`Copyable`](/documentation/Swift/Copyable)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`Escapable`](/documentation/Swift/Escapable)

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

---

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)