<!--
{
  "availability" : [
    "iOS: 10.3.0 -",
    "iPadOS: 10.3.0 -",
    "macCatalyst: 13.1.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 3.2.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Intents",
  "identifier" : "/documentation/Intents/INPaymentAccount",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Intents"
    ],
    "preciseIdentifier" : "c:objc(cs)INPaymentAccount"
  },
  "title" : "INPaymentAccount"
}
-->

# INPaymentAccount

A user account that provides the funds when making a payment.

```
class INPaymentAccount
```

## Overview

An [`INPaymentAccount`](/documentation/Intents/INPaymentAccount) object represents a user account known to your app. When paying bills, you use the specified payment account as the source of any funds involved in the financial transaction. Your app must have the authority to transfer funds from the designated account to any payees.

## Topics

### Initializing the Payment Account

[`init(nickname: INSpeakableString, number: String?, accountType: INAccountType, organizationName: INSpeakableString?, balance: INBalanceAmount?, secondaryBalance: INBalanceAmount?)`](/documentation/Intents/INPaymentAccount/init(nickname:number:accountType:organizationName:balance:secondaryBalance:))

Initializes a payment account object with the specified account information.

[`convenience init?(nickname: INSpeakableString, number: String?, accountType: INAccountType, organizationName: INSpeakableString?)`](/documentation/Intents/INPaymentAccount/init(nickname:number:accountType:organizationName:))

Initializes a payment account object with the specified account information.

### Getting the Account Details

[`var nickname: INSpeakableString?`](/documentation/Intents/INPaymentAccount/nickname)

A user-defined name that identifies the account.

[`var organizationName: INSpeakableString?`](/documentation/Intents/INPaymentAccount/organizationName)

The name of the organization that supplies the account to the user.

[`var accountType: INAccountType`](/documentation/Intents/INPaymentAccount/accountType)

The type of the account.

[`enum INAccountType`](/documentation/Intents/INAccountType)

Constants indicating the type of account involved in a financial transaction.

[`var accountNumber: String?`](/documentation/Intents/INPaymentAccount/accountNumber)

A string to help the user differentiate between similar accounts.

### Getting the Account Balance

[`var balance: INBalanceAmount?`](/documentation/Intents/INPaymentAccount/balance)

The primary balance associated with the account.

[`var secondaryBalance: INBalanceAmount?`](/documentation/Intents/INPaymentAccount/secondaryBalance)

A secondary balance, if any, associated with the account.

[`class INBalanceAmount`](/documentation/Intents/INBalanceAmount)

A balance associated with an account.

### Initializers

[`init?(coder: NSCoder)`](/documentation/Intents/INPaymentAccount/init(coder:))

## Relationships

### Conforms To

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

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

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

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

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

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

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

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

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

### 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)