get/accounts/{accountResourceId}/balances

Item: BalanceResource

• namestringrequired

  Label of the balance

  Constraints: maxLength: 70

• balanceAmountAmountTyperequired

  Schema: AmountType

  • 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}$`

  • currencyCurrencyCoderequired

    Schema: CurrencyCode

• balanceTypeBalanceStatusrequired

  Schema: BalanceStatus

  Code	Name	Description
  CLBD	ISO20022 ClosingBooked	Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
  PRCD	ISO20022 PreviouslyClosedBooked	Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.
  ITAV	ISO20022 InterimAvailable	Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
  XPCD	ISO20022 Expected	Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.
  VALU	(None)	Value-date balance
  OTHR	(None)	Other Balance

• lastChangeDateTimestring (date-time)

  Timestamp of the last change of the balance amount

• referenceDatestring (date-time)

  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

Schema: BalancesLinks

• selfGenericLinkrequired

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• parent-listGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• ownersGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• transactionsGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

• overdraftsGenericLink

  Schema: GenericLink

  • hrefstringrequired

    URI to be used. HREF stands for Hypertext REFerence.

    Constraints: maxLength: 2000

  • templatedboolean

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570.

    This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with

Item: ErrorDetail

• locationstringenum · 2

  Location of the erroneous parameter when not in request body

  Code	Name	Description
  header	—	—
  query	—	—

• namestring

  Name of the erroneous parameter when not in request body

• pathstring

  JsonPath of the erroneous request body property

• erroneousValuestring

  Erroneous parameter value

• messagestring

  Relevant message for the erroneous parameter

• expectedPatternstring

  Expected pattern, if any, that the erroneous parameter does not match with

• expectedValueRangeobject

  Expected value range, if any, that the erroneous parameter does not match with

• expectedValueCountobject

  Expected value count, in the case of an array item, that the erroneous parameter does not match with

• expectedEnumerationarray<string>

  Expected enumeration, if any, that the erroneous parameter do not match with