Page tree
Skip to end of metadata
Go to start of metadata

1.1.Read Account List

Attribute

Type

Condition

Description

X-Request-ID

UUID

Mandatory

ID of the request, unique to the call, as determined by the initiating party (TPP).

Consent-ID

UUID

Mandatory

The consentId of the related AIS consent.

Authorization

String

Mandatory

The oAuth2 Bearer token obtained from the performed SCA performed prior to this request.

API-Key

String

Mandatory

Consumer key available on the developers portal.

PSU-IP-Address

String

Optional

The forwarded IP address header field consists of the corresponding http request IP address field between PSU and TPP.

PSU-IP-Port

String

Optional

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Device-ID

String

Optional

UUID (Universally Unique Identifier) for a device, which is used by the PSU if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device.

PSU-Geo-Location

String

Optional

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.




GET /api/v1/accounts {query-parameters}

Read the identifiers of the available payment account together with balance information depending on the consent granted. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the oAuth2 access token.


Query parameters

Attribute

Type

Condition

Description

withBalance

Boolean

Optional

If contained, this response will include the booking balance, if granted by the PSU in the related consent and available by the ASPSP. Parameter might be ignored.

Request body

No request body

Response Code

HTTP Response Code 200 (OK).

Response headers

Attribute

Type

Condition

Description

X-Request-ID

UUID

Mandatory

ID of the request, unique to the call, as determined by the initiating party (TPP).

Response body

Attribute

Type

Condition

Description

accounts

Array of

Account

Objects

Mandatory

ID of the request, unique to the call, as determined by the initiating party (TPP).

pagination

Pagination

Mandatory

Pagination information about the returned results.



  • No labels