...
The balances resource is used by an AISP to retrieve in bulk or single account balance information for a specific AccountId for that the PSU customer has authorised to access.
This resource description should be read in conjunction with a compatible Account Information Services 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 | Authorization Authorisation Code | No | | | OBReadBalance |
2.2 | balances | GET | GET /balances | Optional | accounts | Authorization Authorisation Code | No | Pagination | | OBReadBalance |
...
4.1.1 Get Balances Request
GET /balances
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json
|
...
200 OK
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
|
{
"Data": {
"Balance": [
{
"AccountId": "00345897",
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2020-03-23T10:22:35.293Z"293+03:00”,
"Amount": {
"Amount": "12500",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Type": "Available",
"Amount": {
"Amount": "10000",
"Currency": "BHD"
}
}
]
},
{
"AccountId": "00145897",
"CreditDebitIndicator": "Debit",
"Type": "InterimAvailable",
"DateTime": "2020-03-23T10:22:35.293Z"293+03:00”,
"CreditLine": [
{
"Included": true,
"Type": "Available",
"Amount": {
"Amount": "10000",
"Currency": "BHD"
}
}
]
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 02,
"FirstAvailableDateTime": "2020-03-12T09:10:17.596Z"596+03:00”,
"LastAvailableDateTime": "2020-03-12T09:10:17.596Z"596+03:00”
}
}
|
4.2. Specific Account
...
GET /accounts/00345897/balances
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json
|
...
{
"Data": {
"Balance": [
{
"AccountId": "00345897",
"CreditDebitIndicator": "Credit",
"Type": "ClosingAvailable",
"DateTime": "2020-03-23T10:22:35.293Z"293+03:00”,
"Amount": {
"Amount": "12500",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Type": "Available",
"Amount": {
"Amount": "10000",
"Currency": "BHD"
}
}
]
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 02,
"FirstAvailableDateTime": "2020-03-12T09:10:17.596Z"596+03:00”,
"LastAvailableDateTime": "2020-03-12T09:10:17.596Z"596+03:00”
}
}
|