ofOpen Finance Guide
GlosarioSTETBlogContacto
Halobject

HalBalances

HYPERMEDIA structure used for returning the list of the relevant balances for a given account to the AISP

Fields (2)

  • balancesarray<BalanceResource>required

    List of account balances

    Item: BalanceResource

    Structure of an account balance

    • namestringrequired

      Label of the balance

      Constraints: maxLength: 70

    • balanceAmountAmountTyperequired

      Structure aiming to embed the amount and the currency to be used.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • balanceTypeBalanceStatusrequired

      Type of balance

      Schema: BalanceStatus

      CodeNameDescription
      CLBD
      		ISO20022 ClosingBookedAccounting Balance
      XPCD
      		ISO20022 ExpectedInstant Balance
      VALU
      		(None)Value-date balance
      OTHR
      		(None)Other Balance
    • lastChangeDateTimestring (date-time)ISO 8601

      Timestamp of the last change of the balance amount

    • referenceDatestring (date-time)ISO 8601

      Reference date for the balance

    • lastCommittedTransactionstring

      Identification of the last committed transaction. This is actually useful for instant balance.

      Identification of the last committed transaction. This is actually useful for instant balance.

      Constraints: maxLength: 40