...
This resource description should be read in conjunction with a compatible Account and Transaction API Profile.
2. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameter | Request Object | Response Object |
2.1 | balances | GET | GET /accounts/{AccountId}/balances | Mandatory | accounts | Authorisation Code | No |
|
| OBReadBalance |
2.2 | balances | GET | GET /balances | Optional | accounts | Authorisation Code | No | Pagination |
| OBReadBalance |
2.1 GET /accounts/{AccountId}/balances
...
The resource requires the ReadBalances permission. The resource response payload does not differ depending on the permissions granted.
3.1.5 Data Dictionary
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}$ |
4. Usage Example
4.1 Bulk
...