Skip to main content

Funds Accounts

Funds accounts represent financial accounts retrieved from account servicing providers (banks, neobanks, payment institutions) via account information services. The FXM module models accounts with their balances, associated parties, statuses, and access consents, following Open Banking patterns for account data representation.

Account structure

Funds accounts

Each account record captures details as provided by the account servicing provider.

FieldPurpose
Account servicing providerThe bank or provider that serves the account
Provider account referencesIdentifiers supplied by the account information provider or bank
Account statusWhether the account is enabled, pending, disabled, or deleted
CurrencyThe account currency
Usage typeBusiness or personal use
Account typeProvider-supplied account type
Account datesOpening date, maturity date, and last known update date
Account namesProvider-supplied name, custom account name, and holder name
Account codeInstitution-assigned account code and code scheme

Access consents

Before account data can be retrieved, the account holder must grant consent to the AISP. The platform records these consents following the Open Banking consent model.

FieldPurpose
Consent service providerThe account information provider receiving access
Account servicing providerThe bank or provider granting access
Consent statusFor example, authorised, awaiting authorisation, or revoked
Consent permissionsThe account data elements the provider may retrieve
Access periodThe transaction date range covered by the consent

Consents are linked to both the AISP and the ASPSP as parties. The consent_permissions field stores an array of granular permission codes that control which account data elements the AISP may retrieve.

Balances

Balance snapshots are recorded over time. Each account can have multiple balance records across different types, currencies, and dates.

FieldPurpose
AccountThe funds account the balance belongs to
Balance valueBalance excluding credit line
Available balanceBalance including available credit
Balance dateDate and time of the balance snapshot
Balance typeClosing, opening, interim, expected, or other standard balance type
CurrencyBalance currency
Credit lineCredit line type and value, where available

Balance types

Balance types follow standard banking conventions:

  • CLOSING_AVAILABLE / CLOSING_BOOKED / CLOSING_CLEARED -- end-of-day balances
  • OPENING_AVAILABLE / OPENING_BOOKED / OPENING_CLEARED -- start-of-day balances
  • INTERIM_AVAILABLE / INTERIM_BOOKED / INTERIM_CLEARED -- intraday balances
  • EXPECTED -- projected balance
  • FORWARD_AVAILABLE -- future-dated available balance
  • INFORMATION -- informational balance
  • PREVIOUSLY_CLOSED_BOOKED -- prior period closing balance

Privacy-enhanced balance view

The public balance view applies privacy protections:

  • account identifiers are replaced with privacy-safe values
  • monetary values are rounded for safer exposure
  • timestamps are reduced to date-only granularity

Parties

Parties (individuals or organisations) are linked to funds accounts with a role designation.

FieldPurpose
AccountThe funds account
Party typeSole account holder, joint account holder, or delegated party
PartyThe individual or organisation linked to the account
Party siteThe relevant address or site, where available
Contact pointThe relevant contact detail, where available

Statuses

Account statuses track the date range of transactions that have been retrieved for an account.

FieldPurpose
AccountThe funds account
Earliest transaction dateEarliest retrieved transaction date
Latest transaction dateMost recent retrieved transaction date

This metadata helps the platform determine what transaction history is available and when to request incremental updates from the AISP.

Access model

Funds accounts, balances, parties, statuses, and transactions are visible only to users who have access to the account. Child information follows the visibility of the parent account.