GRgroupebpce
AISP

Retrieval of an account transaction set (AISP)

Description

This call returns transactions for an account for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query

  • on a given imputation date range
  • past a given incremental technical identification 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) is 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. It may specify some selection criteria. The ASPSP answers by a set of transactions that matches the query.

  • The result may be subject to pagination in order to avoid an excessive result set.
  • Case of no registered transaction on the account, this result will be an empty list. The default transaction set, in the absence of filter query parameter, has to be specified and documented by the implementation. The sort order of transaction might be specific to each ASPSP, due to each Information System constraints.
get/accounts/{accountResourceId}/transactions

Request

  • Base URL
    https://www.10207.oba-bad-me-live-api.banquepopulaire.fr/stet/psd2/v1.6.2
  • Auth
    OAuth 2
    Authorization code: /stet/psd2/oauth/authorize
    Token URL: /stet/psd2/oauth/token scopes: aisp

Path parameters

accountResourceIdstring required

Identification of account resource to fetch

Query parameters

dateFromstring date-time

Inclusive minimal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are included within the result.

dateTostring date-time

Exclusive maximal imputation date of the transactions.

Transactions having an imputation date equal to this parameter are not included within the result.

dateType'transactionDate' | 'bookingDate'

This parameter specifies the type of date on which [dateFrom] and [dateTo] apply. If not provided, the ASPSP will use its own default date type as specified in its implementation documentation. The implementation documentation must also specify which date types are supported.

entryReferenceFromstring

Specifies the value on which the result has to be computed.

Only the transaction having a technical identification greater than this value must be included within the result

entryReferencetostring

Specifies the value on which the result has to be computed.

Only the transaction having a technical identification less than or equal to this value must be included within the result

workspacestring

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

Authorizationstring required

Access token to be passed as a header

PSU-IP-Addressstring

IP address used by the PSU's terminal when connecting to the TPP

PSU-IP-Portstring

IP port used by the PSU's terminal when connecting to the TPP

PSU-HTTP-Methodstring

Http method for the most relevant PSU’s terminal request to the TTP

PSU-Datestring

Timestamp of the most relevant PSU’s terminal request to the TTP

PSU-GEO-Locationstring

Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP

PSU-User-Agentstring

"User-Agent" header field sent by the PSU terminal when connecting to the TPP

PSU-Refererstring

"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-Acceptstring

"Accept" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Charsetstring

"Accept-Charset" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Encodingstring

"Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP

PSU-Accept-Languagestring

"Accept-Language" header field sent by the PSU terminal when connecting to the TPP

PSU-Device-IDstring

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.

Digeststring

Digest of the body

Signaturestring required

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.

X-Request-IDstring required

Correlation header to be set in a request and retrieved in the relevant response

Response

Complete transactions response

Changes

No recorded changes to this operation across all 1 revision of this API.