One Logo Pool Ball
FinanceKit · IOS API REFERENCE

AccountBalance

struct · iOS 17.4+ · SDK 27.1

struct AccountBalance

A structure that describes the financial balance of an account at a specific point in time. The financial balance of an account at a specific point in time.

Members (6)

get · iOS 17.4+

currentBalance

TypeScript
get currentBalance(): CurrentBalance
Swift declaration
let currentBalance: CurrentBalance

The balance at a particular moment in time. It can contain an indication of funds immediately available to the customer, fund with all booked transactions (this excludes pending transactions), or both.

get · iOS 17.4+

currencyCode

TypeScript
get currencyCode(): string
Swift declaration
var currencyCode: String { get }

The balance currency. This is the same across available and booked balances.

get · iOS 17.4+

id

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

A unique account balance ID.

get · iOS 17.4+

booked

TypeScript
get booked(): (Balance) | null
Swift declaration
var booked: Balance? { get }

The booked balance, if present.

get · iOS 17.4+

accountID

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

The account ID the balance belongs to.

get · iOS 17.4+

available

TypeScript
get available(): (Balance) | null
Swift declaration
var available: Balance? { get }

The available balance, if present.

Skipped declarations

No declarations were skipped in this snapshot.

All FinanceKit types →