GRgroupebpce
AISP

Retrieval of an account overdraft (AISP)

Description

This call returns the overdrafts that can be used 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

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. The ASPSP answers by the overdraft that can be applied.

get/accounts/{accountResourceId}/overdrafts

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

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

Overdraft response

Changes

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