TinkMoneyManagerUI Documentation Beta

Structure Account

public struct Account

An account could either be a debit account, a credit card, a loan or mortgage.

Nested Types

Account.Kind

The kind of the account.

Account.AccountExclusion

Indicates which features an account should be excluded from.

Nested Type Aliases

ID

public typealias ID = Identifier<Account>

A unique identifier of an Account.

Initializers

init(id:​credentials​ID:​name:​account​Number:​kind:​transfer​Source​Identifiers:​holder​Name:​is​Closed:​currency​Denominated​Balance:​refreshed:​financial​Institution​ID:​)

public init(id: Account.ID, credentialsID: Credentials.ID, name: String, accountNumber: String, kind: Account.Kind, transferSourceIdentifiers: [URL]?, holderName: String?, isClosed: Bool?, currencyDenominatedBalance: CurrencyDenominatedAmount?, refreshed: Date?, financialInstitutionID: Provider.FinancialInstitution.ID?)

Creates an Account model.

Parameters

id Account.​ID

The internal identifier of account.

credentials​ID Credentials.​ID

The internal identifier of the credentials that the account belongs to.

name String

The display name of the account. This property can be updated in a update account request.

account​Number String

The account number of the account.

kind Account.​Kind

The type of the account.

transfer​Source​Identifiers [URL]?

All possible ways to uniquely identify this Account.

holder​Name String?

The name of the account holder.

is​Closed Bool?

A closed account indicates that it was no longer available from the connected financial institution.

currency​Denominated​Balance Currency​Denominated​Amount?

The current balance of the account.

refreshed Date?

Timestamp of when the account was last refreshed.

financial​Institution​ID Provider.​Financial​Institution.​ID?

A unique identifier to group accounts belonging the same financial institution.

Properties

account​Number

let accountNumber: String

The account number of the account. The format of the account numbers may differ between account types and banks. This property can be updated in a update account request.

credentials​ID

let credentialsID: Credentials.ID

The internal identifier of the credentials that the account belongs to.

is​Favorite

let isFavorite: Bool

Indicates if the user has favored the account. This property can be updated in a update account request.

id

let id: ID

The internal identifier of account.

name

let name: String

The display name of the account. This property can be updated in a update account request.

ownership

let ownership: Double

The ownership ratio indicating how much of the account is owned by the user. The ownership determine the percentage of the amounts on transactions belonging to this account, that should be attributed to the user when statistics are calculated. This property has a default value, and it can only be updated by you in a update account request.

kind

let kind: Kind

The type of the account. This property can be updated in a update account request.

transfer​Source​Identifiers

let transferSourceIdentifiers: [URL]?

All possible ways to uniquely identify this Account; An se-identifier is built up like: se://{clearingnumber}{accountnumber};

holder​Name

let holderName: String?

The name of the account holder.

is​Closed

let isClosed: Bool?

A closed account indicates that it was no longer available from the connected financial institution, most likely due to it having been closed by the user.

account​Exclusion

let accountExclusion: AccountExclusion?

Indicates features this account should be excluded from.

If nil, then no features are excluded from this account.

currency​Denominated​Balance

let currencyDenominatedBalance: CurrencyDenominatedAmount?

The current balance of the account. The definition of the balance property differ between account types. SAVINGS: the balance represent the actual amount of cash in the account. INVESTMENT: the balance represents the value of the investments connected to this accounts including any available cash. MORTGAGE: the balance represents the loan debt outstanding from this account. CREDIT_CARD: the balance represent the outstanding balance on the account, it does not include any available credit or purchasing power the user has with the credit provider. The balance is represented as a scale and unscaled value together with the ISO 4217 currency code of the amount.

refreshed

let refreshed: Date?

Timestamp of when the account was last refreshed.

financial​Institution​ID

let financialInstitutionID: Provider.FinancialInstitution.ID?

A unique identifier to group accounts belonging the same financial institution. Available for aggregated accounts only.