Get Account Balance
➤ Introduction
Using this service, you can get the accounting balance data ("CLBD" in STET) on a payment account authorized by the customer.
It follows the return of the list of current accounts for a customer : a resource identifier corresponding to an account must be provided to obtain the corresponding accounting balance.
Access to this method is limited to a maximum of 4 batch per day for one given TPP and PSU (except if the PSU is connected and has requested it).
➤ Prerequisites
The TPP has previously retrieved the list of available accounts for the PSU :
- Customer's IBAN should have been forwarded to ASPSP in the "transactions" list of the PUT /consents method (see use case "Forward customer's consent")
- The "accountResourceId" is sent in the GET /accounts response / field "resourceId" for this IBAN
- URI or accessing this method is given using the field "_links": {"transactions": {"href": ...}} as a response of the GET /accounts using above "AccountresourceId"
➤ Request
Method "GET /accounts/{accountResourceId}/balances"
See also STET V1.4.2.17 / Part III / section 6.4/ page 9
Mandated parameter
"accountResourceId" : current account for which you want to retrieve transactions history.
This field corresponds to the field "resourceId" obtained in the get/accounts request result page.
➤ Example
You can find an example of this request in section "Test our API" and then "Use our sandbox".
See also STET V1.4.2.17 / Part II / section 4.3.4 / page 31
➤ Acceptance tests
The purpose of these tests is to ensure that the API complies with the STET standard. They should be validated before any application deployment.
Description | Test data |
Get accounting balance => Check negative balance | PSU Persona : LEA PSU context = BY-AISPscope OAuth2 = aisp
Result : message HTTP 200 => OK negative balance returned |
Get accounting balance from an unkown account => check if HTTP 404 is returned | PSU Persona : unkown - CPT30014684067 PSU context = BY-AISP scope OAuth2 = aisp
Result : Error message HTTP 404 returned |
HTTP request with non autorized access token for this resource (wrong scope) => check if HTTP 403 is returned (access refused) | PSU Persona : LEA PSU context = BY-AISP scope OAuth2 < > aisp Result : Error message HTTP 403 returned |
Use a non authorized request (POST) => check if HTTP 405 is returned | Persona : LEA PSU context = BY-AISP scope OAuth2 = aisp
Result : Error message HTTP 405 returned |
Get accounting balance => Check null balance
| PSU Persona : CLAIRE FR7617515900000400358074026 PSU context = BY-AISP scope OAuth2 = aisp Result : message HTTP 200 => OK null balance returned |
Get accounting balance => Check positive balance | Persona : CLAIRE FR7617515900000800358074006 PSU context = BY-AISP scope OAuth2 = aisp
Result : message HTTP 200 => OK positive balance returned |