OpenFinance
Development Portal

Account Information Service (2.3)

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

Retrieve a PSU's account information — account details, balances, transactions, and statements — for the accounts covered by a valid consent.

List transactions

GET /v2/accounts/{account-id}/transactions

Returns an account's transactions — booked or pending — for the requested period.

Parameter Type Description
account-id string , required

Identifier of the account, returned as resourceId in the account list. It stays constant for the account's lifetime.

Example: Text, maximum of 70 characters.

Allowed length: max: 70

Parameter Type Description
dateFrom string , optional

Start date of the transaction list, inclusive. Required unless you use a delta filter or request only information.

Example: 2020-01-01

Format: date

dateTo string , optional

End date of the transaction list, inclusive. Defaults to today.

Example: 2020-01-01

Format: date

entryReferenceFrom string , optional

Delta filter: return transactions recorded after the entry with this reference, instead of a date range.

Example: Text, maximum of 35 characters.

Allowed length: max: 35

bookingStatus string , required

Which transactions to return. booked is always available; the bank may also support the other values. Values are described in Booking status.

Allowed values: information, booked, pending, both, all

Example: booked

deltaList boolean , optional

Delta filter: return transactions added since your last access to this account. The bank may not support it.

Example: true

withBalance boolean , optional

Include the account's balances in the response, when the consent and bank allow.

Example: true

cardBrand string , optional

Filter transactions by card brand. Used only in card-acquirer statement scenarios.

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

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

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

Identifier of the addressed account.

balances array[object] , optional

A list of balances regarding this account, e.g. the current balance, the last booked balance.

transactions object , optional

The account's transactions, split into booked and pending.

_links object , optional

Links to the account, its balances and transactions, and pagination.