HalBalances

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

    Code	Name	Description
    CLBD	ISO20022 ClosingBooked	Accounting Balance
    XPCD	ISO20022 Expected	Instant 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

• _linksBalancesLinksrequired

  links that can be used for further navigation when browsing Account Information at one account level

  Schema: BalancesLinks

  links that can be used for further navigation when browsing Account Information at one account level

  Link	Description
  self	link to the balances of a given account
  parent-list	link to the list of all available accounts
  transactions	link to the transactions of a given account

  • selfGenericLinkrequired

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

  • parent-listGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

  • transactionsGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used. HREF stands for Hypertext REFerence.

      Constraints: maxLength: 2000

    • templatedboolean

      specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false