FinanceKit gives banking, credit, and budgeting apps access to a person's financial data, including accounts, balances, and transactions. You read this data through FinanceStore, requesting an AuthorizationStatus and running queries such as AccountQuery, AccountBalanceQuery, and TransactionQuery to retrieve Account, AccountBalance, and Transaction values. Individual records carry details like CurrencyAmount, CreditDebitIndicator, MerchantCategoryCode, and TransactionStatus, and accounts are modeled as AssetAccount or LiabilityAccount with AccountCreditInformation. For apps that need fresh data, the BackgroundDeliveryExtension and BackgroundDeliveryExtensionProviding protocols support background updates, while FinanceError reports failures.
Essentials 2
Read a person's financial data and request the authorization required to access it.
- ClFinanceStoreSecure storage for Apple Wallet orders and financial data.
- EnAuthorizationStatusValues that describe an app's FinanceKit authorization status.
Accounts 4
Model banking, credit, and asset accounts along with their credit terms.
- EnAccountA structure that describes a financial account.
- StAssetAccountA structure that describes the characteristics of an asset account.
- StLiabilityAccountA structure that describes the characteristics of a liability account.
- StAccountCreditInformationA structure that describes the credit information associated with an account.
Balances 3
Represent the current and historical balances reported for an account.
- StAccountBalanceA structure that describes the financial balance of an account at a specific point in time.
- StBalanceA structure that describes an account balance.
- EnCurrentBalanceValues that describe the state of an account's credit balance.
Transactions 6
Represent individual financial transactions and their classifying metadata.
- StTransactionA structure that represents a transaction relating to a specific financial account.
- EnTransactionStatusValues that describe the status of a transaction.
- EnTransactionTypeValues that describe kinds of transactions.
- EnCreditDebitIndicatorValues that the framework uses to describe transactions as credits or debits.
- StMerchantCategoryCodeA structure that identifies the category of a merchant involved in a transaction.
- StFullyQualifiedOrderIdentifierA structure that specifies the characteristics of an order.
Queries 3
Retrieve accounts, balances, and transactions from the finance store.
- StAccountQueryA structure that defines an account query.
- StAccountBalanceQueryA structure that defines an account balance query.
- StTransactionQueryA structure that describes the parameters to use for a transaction query.
Currency Values 1
Express monetary amounts in a specific currency.
- StCurrencyAmountA structure that describes a monetary amount and its currency.
Background Delivery 2
Receive financial data updates in the background through an app extension.
- PrBackgroundDeliveryExtensionAn extension used to receive updates about changes to data within the finance store.
- PrBackgroundDeliveryExtensionProvidingA protocol that supplies the configuration and behavior for a background delivery extension.
Errors 1
Handle failures that occur while accessing financial data.
- EnFinanceErrorValues that describe errors that may occur when accessing financial data.