After successfull authorisation of account access consent an AISP may retreive account balance using GET endpoints.
Required permissions: ReadBeneficiariesBasic or ReadBeneficiariesDetail (the most detailed level).
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/accounts/beneficiaries
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": {
"Beneficiary": [
{
"AccountId": "22289",
"BeneficiaryId": "Ben1",
"Reference": "Towbar Club",
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH10BBKU00100000003385",
"Name": "Mrs Juniper"
}
},
{
"AccountId": "31820",
"BeneficiaryId": "Ben37",
"Reference": "Golf Club",
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH10BBKU00100000113385",
"Name": "Mr Large"
}
}
]
},
"Links": {
"Self": {"href": "/beneficiaries"}
},
"Meta": {
"TotalPages": 1
}
}
An AISP may retrieve the account balance information resource for a specific AccountId (which is retrieved in the call to GET /accounts).
Required permissions: ReadBeneficiariesBasic or ReadBeneficiariesDetail (the most detailed level).
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/accounts/_e-VLgkAQ-qYxFvW6vb64g/beneficiaries
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": {
"Beneficiary": [
{
"AccountId": "22289",
"BeneficiaryId": "Ben1",
"Reference": "Towbar Club",
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH10BBKU00100000003385",
"Name": "Mrs Juniper"
}
}
]
},
"Links": {
"Self": "{"href": "/accounts/_e-VLgkAQ-qYxFvW6vb64g/beneficiaries"}
},
"Meta": {
"TotalPages": 1
}