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.

Get balances

GET /v2/cards/{card-id}/balances

Reads balance data from a given card addressed by "card-id". See "Implementation Guidelines for Extended Services ", section "Read Card Balances".

Parameter Type Description
card-id string , required

This identification is denoting the addressed card. The card-id is retrieved by using a "Read Card List" call. The card-id is the "resourceId" attribute of the card structure. Its value is constant at least throughout the lifecycle of a given consent.

Example: Text, maximum of 70 characters.

Allowed length: max: 70

Parameter Type Description
dateFrom string , optional

Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information". For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.

Example: 2020-01-01

Format: date

valueDateFrom string , optional

Requests in addition to the balances of the current accounting period all balances at the end of previous accounting periods (e.g. monthly periods) with payment due date starting from the provided date on if still retrievable under the given consent. Note: The accounting period is the invoicing period of the related card.

Example: 2020-01-01

Format: date

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

PSU-IP-Address string , optional

IP address of the PSU's device as forwarded by the TPP. If unavailable, use the IP address the TPP used for this request.

Example: 192.168.8.78

Format: ipv4

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
card object , required

Identifier of the addressed card.

balances array[object] , required

A list of balances regarding this card.

debitAccounting boolean , optional

If true, the amounts of debits on the reports are quoted positive with the related consequence for balances. If false, the amount of debits on the reports are quoted negative.