After successfull authorisation of account access consent an AISP may retreive account balance using GET endpoints.
Required permissions: ReadBalances.
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/balances
Authorisation: 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
Accept: application/json
Response:
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"AccountId": "HtmXXkRsQvWaXE1gKFuAQA",
"CreditDebitIndicator": "Credit",
"Type": "Available",
"DateTime": "2021-07-16T10:48:42.731+03:00[Europe/Moscow]",
"Amount": {
"Amount": "126.624",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "200.000",
"Currency": "BHD"
},
"Type": "Available"
}
]
},
{
"AccountId": "DcABDNVxTyS5mjTbh5TSnQ",
"CreditDebitIndicator": "Credit",
"Type": "Available",
"DateTime": "2021-07-16T10:48:42.873+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119348.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.0000",
"Currency": "BHD"
},
"Type": "Available"
}
]
},
{
"AccountId": "DcABDNVxTyS5mjTbh5TSnQ",
"CreditDebitIndicator": "Credit",
"Type": "Book",
"DateTime": "2021-07-16T10:48:42.873+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119349.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.000",
"Currency": "BHD"
},
"Type": "Available"
}
]
},
{
"AccountId": "nRQ2hx4zRHmeSkeq591lFA",
"CreditDebitIndicator": "Credit",
"Type": "Available",
"DateTime": "2021-07-16T10:48:42.935+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119348.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.000",
"Currency": "BHD"
},
"Type": "Available"
}
]
},
{
"AccountId": "nRQ2hx4zRHmeSkeq591lFA",
"CreditDebitIndicator": "Credit",
"Type": "Book",
"DateTime": "2021-07-16T10:48:42.935+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119349.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.000",
"Currency": "BHD"
},
"Type": "Available"
}
]
},
{
"AccountId": "omfDJFGYQmC2gFk9jDCxBg",
"CreditDebitIndicator": "Credit",
"Type": "Available",
"DateTime": "2021-07-16T10:48:42.977+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119348.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.000",
"Currency": "BHD"
},
"Type": "Credit"
}
]
},
{
"AccountId": "omfDJFGYQmC2gFk9jDCxBg",
"CreditDebitIndicator": "Credit",
"Type": "Book",
"DateTime": "2021-07-16T10:48:42.977+03:00[Europe/Moscow]",
"Amount": {
"Amount": "9119349.264",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "150000.000",
"Currency": "BHD"
},
"Type": "Credit"
}
]
}
]
},
"Links": "www.bank.com"
}
An AISP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).
Required permissions: ReadBalances.
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/accounts/HtmXXkRsQvWaXE1gKFuAQA/balances
Authorisation: 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
Accept: application/json
Response:
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"AccountId": "HtmXXkRsQvWaXE1gKFuAQA",
"CreditDebitIndicator": "Credit",
"Type": "Available",
"DateTime": "2019-07-16T10:55:14.513+03:00[Europe/Moscow]",
"Amount": {
"Amount": "126.624",
"Currency": "BHD"
},
"CreditLine": [
{
"Included": true,
"Amount": {
"Amount": "200.000",
"Currency": "BHD"
},
"Type": "Credit"
}
]
}
]
},
"Links": "www.bank.com"
}