class · iOS 17.0+ · SDK 27.1
class FinanceStoreSecure storage for Apple Wallet orders and financial data.
transactions(query: TransactionQuery): Promise<Array<Transaction>>func transactions(query: TransactionQuery) async throws -> [Transaction]Returns transactions that match the provided transaction query. - Parameter query: A ``TransactionQuery`` that describes the kinds of transactions to look for. - Returns: An array of ``Transaction`` records that match the provided `query`.
containsOrder(fqoid: FullyQualifiedOrderIdentifier, updatedDate?: (globalThis.Date) | null): Promise<FinanceStore_ContainsOrderResult>func containsOrder(matching fqoid: FullyQualifiedOrderIdentifier, updatedDate: Date? = nil) async throws -> FinanceStore.ContainsOrderResultChecks whether the finance store contains an order. This returns `.notFound` for any orders that the process isn't entitled to access.
accountHistory(token?: (FinanceStore_HistoryToken) | null, isMonitoring?: boolean): FinanceStore_History<Account>func accountHistory(since token: FinanceStore.HistoryToken? = nil, isMonitoring: Bool = true) -> FinanceStore.History<Account>Returns a list of accounts a person added since a time specified by the provided financial history token. Use this method to list and monitor accounts present in a person's Wallet. If provided, the framework uses the `since` history token as a starting point to evaluate which accounts to return. - Parameters: - token: An optional `HistoryToken`. - isMonitoring:A Boolean value that indicates if the framework should return a `History` that indicates the changes to the accounts over time. Defaults to `true.` - Returns: A `History` that describes the accounts.
accountBalances(query: AccountBalanceQuery): Promise<Array<AccountBalance>>func accountBalances(query: AccountBalanceQuery) async throws -> [AccountBalance]Returns a list of balances that meet the criteria in the provided account query. - Parameters: - query: An ``AccountQuery`` that describes the kinds of accounts to look for. - Returns: An array of ``AccountBalance`` structures.
static isDataAvailable(type: FinanceStore_DataType): booleanstatic func isDataAvailable(_ type: FinanceStore.DataType) -> BoolReturns a Boolean value that indicates if data that represents the provided type is available in the finance store.
transactionHistory(accountID: string, token?: (FinanceStore_HistoryToken) | null, isMonitoring?: boolean): FinanceStore_History<Transaction>func transactionHistory(forAccountID accountID: UUID, since token: FinanceStore.HistoryToken? = nil, isMonitoring: Bool = true) -> FinanceStore.History<Transaction>Returns the transactions for the specified account ID, optional starting time, and monitoring indicator for long running transaction queries. Use this method to search the finance store for transactions in a specific account and receive updates as the framework enters new transactions into the finance store. You can, optionally, specify a starting date and time by providing a `historyToken`. - Parameters: - accountID: an account identifier. - token: An optional ``HistoryToken`` that describes a start time. - isMonitoring: A Boolean value that indicates the method should return records asynchronously as the system updates the FinanceStore. - Returns: A ``History`` of transactions that match the provided `accountID`.
authorizationStatus(): Promise<AuthorizationStatus>func authorizationStatus() async throws -> AuthorizationStatusChecks the authorization status for the calling application. - Returns: An ``AuthorizationStatus`` value that indicates the current state of authorization.
requestAuthorization(): Promise<AuthorizationStatus>func requestAuthorization() async throws -> AuthorizationStatusPrompts a person to give FinanceKit authorization to access financial data. If there are no accounts are available to display, the framework presents a "No Accounts" screen and returns a status of ``AuthorizationStatus/authorized`` or ``AuthorizationStatus/denied`` depending on the state of a person's consent. It's safe to call this method multiple times; the framework prompts a person only if necessary. - Returns: An ``AuthorizationStatus`` value that indicates the current state of authorization.
accountBalanceHistory(accountID: string, token?: (FinanceStore_HistoryToken) | null, isMonitoring?: boolean): FinanceStore_History<AccountBalance>func accountBalanceHistory(forAccountID accountID: UUID, since token: FinanceStore.HistoryToken? = nil, isMonitoring: Bool = true) -> FinanceStore.History<AccountBalance>Returns the account balance history since a time specified by the provided financial history token. Use this method to monitor the balance of a specific account. Provide a `historyToken` to specify a starting data and time. - Parameters: - accountIDs: A list with <doc://com.apple.documentation/documentation/Foundation/UUID> that identifies specific accounts a person has added to the finance store. - token: An optional `HistoryToken` that defines the starting date and time to return records from. - isMonitoring: A Boolean value that indicates whether the framework should return a `History` sequence that indicates the changes to the accounts over time. Defaults to `true`. - Returns: A `History` that describes the account balances.
enableBackgroundDelivery(types: Array<FinanceStore_BackgroundDataType>, frequency: FinanceStore_UpdateFrequency): voidfunc enableBackgroundDelivery(for types: [FinanceStore.BackgroundDataType], frequency: FinanceStore.UpdateFrequency)Enables background delivery for the specified types and frequency. The app's background delivery extension will receive updates at the specified frequency when data of the given types change in the finance store. > Note: Subsequent calls with the same type will update the delivery frequency. - Parameters: - types: The types of data to enable updates for. - frequency: The frequency at which updates should occur.
disableBackgroundDelivery(types: Array<FinanceStore_BackgroundDataType>): voidfunc disableBackgroundDelivery(for types: [FinanceStore.BackgroundDataType])Disables background delivery for the specified types. The app's background delivery extension will no longer receive updates when data of the given types change in the finance store. - Parameter types: The types of data to disable updates for.
disableAllBackgroundDelivery(): voidfunc disableAllBackgroundDelivery()Disables background delivery for all data types. The app's background delivery extension will no longer receive updates when data changes in the finance store.
static get shared(): FinanceStorestatic let shared: FinanceStoreThe shared instance of the store that you make calls through.
accounts(query: AccountQuery): Promise<Array<Account>>func accounts(query: AccountQuery) async throws -> [Account]Returns a list of accounts a person added to their Wallet that meet the criteria in the provided account query. - Parameters: - query: An ``AccountQuery`` that describes the kinds of accounts to look for. - Returns: An array of ``Account`` structures.
saveOrder(signedArchive: ArrayBuffer): Promise<FinanceStore_SaveOrderResult>func saveOrder(signedArchive: Data) async throws -> FinanceStore.SaveOrderResultAdds an order to the store or updates an existing order. `Data` must be the archive data of a valid, signed order.
No declarations were skipped in this snapshot.