/stet/psd2/v1.6.2/accounts
GET - accountsGet_v1.6.2
Résumé
Retrieval of the PSU accounts (AISP)
Description
### Description This call returns all payment accounts that are relevant for the PSU on behalf of whom the AISP is connected. Thanks to HYPERMEDIA, each account is returned with the links aiming to ease access to the relevant transactions and balances. The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results. ### 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. ### Business Flow The TPP sends a request to the ASPSP for retrieving the list of the PSU payment accounts. The ASPSP computes the relevant PSU accounts and builds the answer as an accounts list. The result may be subject to pagination in order to avoid an excessive result set. Each payment account will be provided with its characteristics.
Scopes
- cbpii
- pisp
- extended_transaction_history
- aisp
Paramètres
Authorization (required) | string header Access token to be passed as a header |
PSU-IP-Address | string header IP address used by the PSU's terminal when connecting to the TPP |
PSU-IP-Port | string header IP port used by the PSU's terminal when connecting to the TPP |
PSU-HTTP-Method | string header Http method for the most relevant PSU’s terminal request to the TTP |
PSU-Date | string header Timestamp of the most relevant PSU’s terminal request to the TTP |
PSU-GEO-Location | string header Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP |
PSU-User-Agent | string header "User-Agent" header field sent by the PSU terminal when connecting to the TPP
|
PSU-Referer | string header "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.
|
PSU-Accept | string header "Accept" header field sent by the PSU terminal when connecting to the TPP
|
PSU-Accept-Charset | string header "Accept-Charset" header field sent by the PSU terminal when connecting to the TPP
|
PSU-Accept-Encoding | string header "Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP
|
PSU-Accept-Language | string header "Accept-Language" header field sent by the PSU terminal when connecting to the TPP
|
PSU-Device-ID | string header 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 | string header Digest of the body |
Signature (required) | string header [http-signature of the request](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/)
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.
|
X-Request-ID (required) | string header Correlation header to be set in a request and retrieved in the relevant response
|
workspace | string query 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.
|
Codes retour
200 | The ASPSP return a PSU context - listing the accounts that were made available to the AISP by the PSU and, - for each of these accounts, the further transactions that were enabled by the PSU through HYPERMEDIA links. |
204 | No content. |
401 | Unauthorized, authentication failure. |
403 | Forbidden, authentication successful but access to resource is not allowed. |
404 | Not found, no request available. |
405 | Method Not Allowed. |
406 | Not Acceptable. |
408 | Request Timeout. |
429 | Too many requests. |
500 | Internal server error. |
503 | Service unavailable. |
Sorties
application/hal+json; charset=utf-8
application/json; charset=utf-8
Authentifications disponibles
OAuth 2.0