Retrieval of an account balances report (AISP)
Description
This call returns a set of balances for a given PSU account that is specified by the AISP through an account resource Identification
Prerequisites
- The TPP was registered by the Registration Authority for the AISP role
- The TPP and the PSU have a contract that was enrolled by the ASPSP
- At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. § 3.4.2).
- The TPP and the ASPSP have successfully processed a mutual check and authentication
- The TPP has presented its OAUTH2 "Authorization Code" or "Resource Owner Password" access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any.
- The ASPSP takes into account the access token that establishes the link between the PSU and the AISP.
- The TPP has previously retrieved the list of available accounts for the PSU
Business flow
The AISP requests the ASPSP on one of the PSU's accounts. The ASPSP answers by providing a list of balances on this account.
- The ASPSP should provide at least one balance on the account.
- For cash account, this balance should be the accounting balance (CACC)
- For card transactions account, the accounting balance is meaningless and must be replaced by an other type of balance (OTHR).
- Case of no registered transaction on the account, this balance will have an amount equal to zero.
- The ASPSP can provide other balance restitutions, e.g. instant balance, as well, if possible.
- Actually, from the PSD2 perspective, any other balances that are provided through the Web-Banking service of the ASPSP must also be provided by this ASPSP through the API.
Request
- Base URLhttps://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2
- AuthOAuth 2Authorization code: /stet/psd2/oauth/authorizeToken URL: /stet/psd2/oauth/token scopes: aisp
Path parameters
Identification of account resource to fetch
Query parameters
Workspace to be used for processing an AISP request. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.
Headers
Access token to be passed as a header
IP address used by the PSU's terminal when connecting to the TPP
IP port used by the PSU's terminal when connecting to the TPP
Http method for the most relevant PSU’s terminal request to the TTP
Timestamp of the most relevant PSU’s terminal request to the TTP
Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP
"User-Agent" header field sent by the PSU terminal when connecting to the TPP
"Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood.
"Accept" header field sent by the PSU terminal when connecting to the TPP
"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
"Accept-Language" header field sent by the PSU terminal when connecting to the TPP
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device.
Digest of the body
http-signature of the request The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate.
Correlation header to be set in a request and retrieved in the relevant response
Response
The ASPSP answers with a list of account balances
Changes
No recorded changes to this operation across all 1 revision of this API.