OpenFinance
Development Portal

openFinance API Framework Extended Account Information Services (2.2)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

The core XS2A Interface as introduced above is already supporting Account Information Services (AIS) for current accounts and card reconciliation accounts. These services follow the functionality of online channels of the related ASPSP: Via the services, information on accounts, balances and transactions can be requested for the supported account types. Each request must refer to an underlying consent from the PSU that grants the TPP access to the requested information. For the envisaged Extended Services, the account information function of the openFinance API will go beyond account types defined by the core XS2A Interface. As new entities as a basis of information, the following are supported: * single cards (in contrast to card reconciliation accounts) * savings accounts * loan accounts * securities accounts. Note: Even if introduced for TPP related scenarios, the related premium payment services and related technical endpoints could also be offered in a direct access scenario e.g. for corporates of an ASPSP to request information on their corresponding accounts / cards directly.

List statements

GET /v2/account-statements

This call retrieves statements for all current accounts that the PSU has access to under the related PSU-ID and has provided consent.

Parameter Type Description
fromDateTime string , optional

Date and time at which the period of the account statement starts. The ASPSP is not mandated to interpret the time fraction of the timestamp. In this case, the validation would use only the presented date and provide statements accordingly. If the API Client wants to retrieve the statements for the whole day, the value 00:00:00 shall be used as time fraction in the timestamp. In case no starting period has been specified, the retrieved account statement shall contain the statement of the current period, where the chosen period is implementation specific. Furthermore, the ASPSP may mandate the usage of this query parameter.

Example: 2020-01-01T13:00:00.999-01:00

Format: date-time

toDateTime string , optional

Date and time at which the period of account statement ends. The ASPSP is not mandated to interpret the time fraction of the timestamp. In this case, the validation would use only the presented date and provide statements accordingly. If the API Client wants to retrieve the statements for the whole day, the value 24:00:00 shall be used as time fraction in the timestamp. In case no ending period has been specified, the retrieved account statement shall contain the statement from the starting point of time till the date/time of the request.

Example: 2020-01-01T13:00:00.999-01:00

Format: date-time

cardBrand string , optional

This attribute filters transactions according to their corresponding card brand. Only to be supported in a scenario, where this is used as statements e.g. of card acquirers towards merchants..

Example: Text, maximum of 35 characters.

Allowed length: max: 35

Header Type Description
Digest string , optional

Integrity hash of the request body in the form SHA-256=<base64>. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built.

Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=

x-jws-signature string , optional

Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed.

X-Request-ID string , required

Unique ID of the request, set by the initiating party and echoed back in the response.

Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

Format: uuid

API-Contract-ID string , optional

Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.

Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555

Format: uuid

Consent-ID string , optional

Identifier of the consent that authorises this access, as returned when the consent was created.

Example: 123cons456

Allowed length: max: 70

Select a status code to see the structure and an example of the response.

Field Type Description
messageId string , required

Point to point reference, as assigned by the sending party, to unambiguously identify the batch of transactions.

statement array[object] , required

Usage Rule: For /accounts/{account-id}/statements only a single statement element will be provided. For /account-statements there will be one statement element for each account which is addressable by the PSU under the related consent.

pageNumber integer , optional

Page number.

creationDateTime string , required

Date and time at which the message was created.

Format: date-time

messageRecipient object , optional

Party authorised by the account owner to receive information about movements on the account.

lastPageIndicator boolean , optional

Indicates the last page.