After successfull authorisation of account access consent an AISP may retreive account balance using GET endpoints.
If an ASPSP has implemented the bulk retrieval endpoints, an AISP may optionally retrieve the account information resources in bulk using .
Required permissions: ReadBalances.
Related security requirements: request must contain consent access token.
Request:
GET https://pg:8745/api/accounts/beneficiaries
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwiY29uc2VudElkIjoiUFhRZDhFRFBTeUNKU0stWmZZdU5jUSIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTU2MzQ1MDAyMywiaWF0IjoxNTYzMzYzNjIzfQ.VrsmH_e_Lq5Ify6IA-mL8Qd9_m5vhfbtMUH8VZJAFMm8B4feoC9KzsSE91W3RAvDPe_SOJtsFZitFY_dk4q-vHRgzfNr1vxPpAurBzEG70gV0cdk5gv8nlYdUIWLs79BLw12TJKLdC_C1ZxYKR_0dvQoshs_9cLTjBt58qfgcWwtQMwk8ruegUxw6XiZz0TtX80hOE10t0dsagPGAiUdjI7XMWEs8Ic62M5jomKDVS-epoFmjyGzIOKcrmdaLalX4boBnpymjDPuYseTyCVtY9EhPAIzV6ot8p_GB0ydzQd3_sW4egj8MZCMCpeIGLpxH98TXK2hzN_RUoYQsYBzWg
Accept:application/json
UserAgent:gZqxcbHPQaKjAAeNlEzKLA
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": "PAN",
"Identification": "80200112345678",
"Name": "Mrs Juniper"
}
},
{
"AccountId": "31820",
"BeneficiaryId": "Ben37",
"Reference": "Golf Club",
"CreditorAccount": {
"SchemeName": "PAN",
"Identification": "87562298675421",
"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: ReadBalances.
Related security requirements: request must contain consent access token.
Request:
GET https://pg:8745/api/accounts/_e-VLgkAQ-qYxFvW6vb64g/beneficiaries
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwiY29uc2VudElkIjoidm9uNHdlbDFTVm1GOGJxVkJWekNaQSIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTU2MzI5NjUzMSwiaWF0IjoxNTYzMjEwMTMxfQ.JjoZgEsnBQDMhj7V1Gr81eEJFzS0c4t37mqiaCgwmXBCu3RPVH-tsdVXi-3Ghen2gMM0VzDXcbwlydvW43XB1nDHkRPO1css2kPhayKH50W7ZmK2f9hgAzdSUkOEw8Fjip9qnqK-WMZSQXKYcaIKZi3QTZK6PITl0Ozo4uFW0EL35eNtp7IKMr3rS3PDNggdhzD_h2Un6k_n-eXX1vn_GK8xq6F0OCllN4g6n0oMmcVWo-0k07EpxxsfFn6WF0qjt-OhEXE-EEivzJbyW51YtX5t96PLvxyS-ZEKhjf6jrKuBaRvffGI6aTuy45AxufSIOgU6Z6ni_Wq4hLvvgJdaQ
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": "PAN",
"Identification": "80200112345678",
"Name": "Mrs Juniper"
}
}
]
},
"Links": {
"Self": "{"href": "/accounts/_e-VLgkAQ-qYxFvW6vb64g/beneficiaries"}
},
"Meta": {
"TotalPages": 1
}