...
Multiple balances may be returned (each with a different value for Type) for an account. This is for ASPSPs that show multiple balances in their online channels.
The CreditLine section may be repeated as multiple credit lines may be included in an available balance.
A DateTime element has been used instead of a complex choice element of Date and DateTime. Where time elements do not exist in ASPSP systems, the time portion of the DateTime element will be defaulted to 00:00:00+03:00.
4.1.4 Permission Codes
The resource requires the ReadBalances permission. The resource response payload does not differ depending on the permissions granted.
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBReadBalance |
| OBReadBalance |
| OBReadBalance |
|
|
Data | 1..1 | OBReadBalance/Data |
| OBReadBalance/Data |
|
|
Balance | 1..n | OBReadBalance/Data/Balance | Set of elements used to define the balance details. | OBReadBalance/Data/Balance |
|
|
AccountId | 1..1 | OBReadBalance/Data/Balance/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
|
CreditDebitIndicator | 1..1 | OBReadBalance/Data/Balance/CreditDebitIndicator | Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. | OBCreditDebitCode | Enum:
|
|
Type | 1..1 | OBReadBalance/Data/Balance/Type | Balance type, in a coded form. | OBBalanceTypeCode | Enum:
|
|
DateTime | 1..1 | OBReadBalance/Data/Balance/DateTime | Indicates the date (and time) of the balance. | DateTime |
|
|
Amount | 1..1 | OBReadBalance/Data/Balance/Amount | Amount of money of the cash balance. | OBReadBalance/Data/Balance/Amount |
|
|
Amount | 1..1 | OBReadBalance/Data/Balance/Amount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount |
| ^\d{1,13}$|^\d{1,13}.\d{1,5}$ |
Currency | 1..1 | OBReadBalance/Data/Balance/Amount/Currency | 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". | ActiveOrHistoricCurrencyCode |
| ^[A-Z]{3,3}$ |
CreditLine | 0..n | OBReadBalance/Data/Balance/CreditLine | Set of elements used to provide details on the credit line. | OBReadBalance/Data/Balance/CreditLine |
|
|
Included | 1..1 | OBReadBalance/Data/Balance/CreditLine/Included | Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account | xs:boolean |
|
|
Type | 0..1 | OBReadBalance/Data/Balance/CreditLine/Type | Limit type, in a coded form. | String | Enum:
|
|
Amount | 0..1 | OBReadBalance/Data/Balance/CreditLine/Amount | Amount of money of the credit line. | OBReadBalance/Data/Balance/CreditLine/Amount |
|
|
Amount | 1..1 | OBReadBalance/Data/Balance/CreditLine/Amount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount |
| ^\d{1,13}$|^\d{1,13}.\d{1,5}$ |
Currency | 1..1 | OBReadBalance/Data/Balance/CreditLine/Amount/Currency | 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". | ActiveOrHistoricCurrencyCode |
| ^[A-Z]{3,3}$ |
...