One Logo Pool Ball
FinanceKit · IOS API REFERENCE

Transaction

struct · iOS 17.4+ · SDK 27.1

struct Transaction

A structure that represents a transaction relating to a specific financial account. This can include transactions such as a deposit to or a withdrawn from bank account, a credit card transaction.

Members (14)

get · iOS 17.4+

originalTransactionDescription

TypeScript
get originalTransactionDescription(): string
Swift declaration
let originalTransactionDescription: String

The unmodified description of the transaction.

get · iOS 17.4+

postedDate

TypeScript
get postedDate(): (globalThis.Date) | null
Swift declaration
let postedDate: Date?

The date and time that the transaction was posted to the account. If not provided, use ``transactionDate`` as `postedDate`.

get · iOS 17.4+

merchantName

TypeScript
get merchantName(): (string) | null
Swift declaration
let merchantName: String?

The name of the merchant, if present.

get · iOS 17.4+

transactionDate

TypeScript
get transactionDate(): globalThis.Date
Swift declaration
let transactionDate: Date

The time the transaction took place, if available. This may be different from the time the transaction posted to the account.

get · iOS 17.4+

transactionType

TypeScript
get transactionType(): TransactionType
Swift declaration
let transactionType: TransactionType

The type of the transaction. This value describes the specific kind of transaction, such as a purchase, a bill, a funds transfer, and so on. The transaction type may not always be available.

get · iOS 17.4+

transactionAmount

TypeScript
get transactionAmount(): CurrencyAmount
Swift declaration
let transactionAmount: CurrencyAmount

The total amount of the transaction.

get · iOS 17.4+

creditDebitIndicator

TypeScript
get creditDebitIndicator(): CreditDebitIndicator
Swift declaration
let creditDebitIndicator: CreditDebitIndicator

An indicator that describes if the transaction is a credit or a debit.

get · iOS 17.4+

merchantCategoryCode

TypeScript
get merchantCategoryCode(): (MerchantCategoryCode) | null
Swift declaration
let merchantCategoryCode: MerchantCategoryCode?

The ISO 18245 category code for the transaction.

get · iOS 17.4+

foreignCurrencyAmount

TypeScript
get foreignCurrencyAmount(): (CurrencyAmount) | null
Swift declaration
let foreignCurrencyAmount: CurrencyAmount?

The total amount of the transaction, if it was carried out in a foreign currency.

get · iOS 17.4+

transactionDescription

TypeScript
get transactionDescription(): string
Swift declaration
let transactionDescription: String

A description of the transaction. For example, a merchant name, or details about the person being paid.

get · iOS 18.0+

foreignCurrencyExchangeRate

TypeScript
get foreignCurrencyExchangeRate(): (_Foundation_Decimal) | null
Swift declaration
let foreignCurrencyExchangeRate: Decimal?

The currency exchange rate, if the transaction was carried out in a foreign currency.

get · iOS 17.4+

id

TypeScript
get id(): string
Swift declaration
let id: UUID

A unique internal ID.

get · iOS 17.4+

status

TypeScript
get status(): TransactionStatus
Swift declaration
let status: TransactionStatus

The status of the transaction, if available.

get · iOS 17.4+

accountID

TypeScript
get accountID(): string
Swift declaration
let accountID: UUID

The account ID the transaction belongs to.

Skipped declarations

No declarations were skipped in this snapshot.

All FinanceKit types →