Retrieve account balances for accounts associated with an authorized consent
View Balances API allows applications to retrieve balance information for an account associated with a previously authorized consent.
Access to this API requires a valid consent that has been authorized by the customer.
consentId must refer to an active and authorized consentAuthorization: Bearer headerThis API can only be accessed using a valid and active consent. Before accessing this service, ensure that a consent has been created and authorized with the required useCaseType and permissions.
The consent must include the appropriate useCaseType and permission values that allow access to the corresponding financial data services.
If you do not already have a consent with the required configuration, you must first create one using the Create Consent API and ensure that it is successfully authorized. Once the consent becomes active, the generated consentId can be used to access this API service.
Scope | useCaseType | Permissions |
|---|---|---|
To access all AIS API services:
|
|
|
This service requires consentId and accountId returns to return the balance of an account associated with that consent.
Endpoint URL | Method |
|---|---|
| GET |
The following headers must be included when calling the Balance API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request GET \
--url 'https://obsandbox.onesingleview.com/v2/api/observice/balanceById?dateTimeStamp=2023-06-14T17%3A51%3A03&requestID=db35902b-806a-4141-b1e2-e93f60c82f62&merchantId=APIU-300356&bankCode=SAMA&consentId=urn%3ASABBSARI%3Akac-cd3b9a37-eb97-4a70-b268-38af9f2950b1&accountId=100004000000000000000001' \
--header 'accept: application/json' \
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNYVR4WGpBZU5qU1FWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUZ1TTJ6NmIzbi9WVE1aK1FucERJMEZXWWN6VGJsOEc5cXhaY0VLUTZZWEFsYmZnejdkdlFpTTRXeVBNalQ2WG1NUDh5YXI4RDVWZTUwUGhYbDcwYkYxRENJeEpDaU5TVkhBKytXYnRUZkhDblVBPT0iLCJpYXQiOjE3ODE1OTAwMDksImV4cCI6MTc4MTU5MzYwOX0.MO69uVzXyHqN2UBxvxCn3sBZcOpNWYP7bsQPe-qdGsQ'Request parameters
Parameters | Requirement | Description | Data type | Data validation |
|---|---|---|---|---|
dateTimeStamp | Mandatory | Indicates the date and time when the request is created | Date | ISO 8601 format |
requestID | Mandatory | Unique identifier for the request used for tracking and traceability | Alphanumeric | UUID format |
merchantID | Mandatory | Identifier assigned to the merchant or client application initiating the request | String |
|
bankCode | Mandatory | Unique bank identifier code | Enum |
|
consentId | Mandatory | Unique identifier of the consent | String |
|
accountId | Mandatory | Unique identifier of the account | String |
|
{
"success": true,
"payload": [
{
"code": "SAMA",
"data": {
"accountId": "100004000000000000000002",
"balance": [
{
"amount": {
"amount": "1091.70",
"currency": "SAR"
},
"creditDebitIndicator": "KSAOB.Credit",
"type": "KSAOB.ClosingAvailable",
"dateTime": "2022-09-14T09:55:54.217Z",
"creditLine": [
{
"included": true,
"type": "KSAOB.Temporary",
"amount": {
"amount": "1000.00",
"currency": "SAR"
}
}
]
}
]
},
"links": {
"self": "https://rs1.lab.openbanking.sa/open-banking/account-information/2022.11.01-final-errata2/accounts/100004000000000000000002/balances"
},
"meta": {
"totalPages": 1
}
}
]
}
Response parameters
Parameter | Description | Data type | Data validation |
|---|---|---|---|
success | Indicates whether the request was successfully processed | Enum |
|
payload | Contains account information grouped by bank | Array of objects |
|
code | Bank identifier associated with the account data | Enum |
|
data | Contains account details returned from the bank | Object |
|
accountId | Unique identifier of the account | String |
|
balance | Tag carrying account balance information |
|
|
amount | Tag carrying cash balance information |
|
|
amount | Cash balance amount |
|
|
currency | Default currency of the account in which the balance is indicated |
|
|
creditDebitIndicator | Indicates whether the balance is a credit or a debit balance |
|
|
type | Indicator type details |
|
|
dateTime | Date and time information of the indicator |
|
|
creditLine | Tag carrying credit line information |
|
|
included | Status of credit line as |
|
|
type | Type of credit line details |
|
|
amount | Tag carrying amount information of credit line |
|
|
amount | Available amount in credit line |
|
|
currency | Currency in which the credit line balance is indicated |
|
|
links | Redirect link |
|
|
self | Own link/URL details |
|
|
meta | Meta tag |
|
|
totalPages | Information displayed in terms of pages |
|
|