Consent-based access
For consent-based access, use the consent_id
from the response of the AppScreen request to access the transactions.
Retrieve consent-based transactions
Using the access token requested in the authentication chapter, retrieve the transactions using endpoint:
Use the following request parameters:
Parameter
Required
Description
consentId
Yes or use accountId *
The Consent ID (retrieved as parameter from the consent redirect URI).
pageSize
No
(default 100,
maximum 1000)
(default 100,
maximum 1000)
The number of results retrieved per page.
pageToken
No
(default empty)
(default empty)
The
pagetoken
retrieves a specific result page. Leave empty to receive first page.accountId
No *
The Account ID is used to retrieve transactions only from this specific account.
dateFrom
No
(default empty)
(default empty)
The
If a date-only value is provided, all transactions with a UTC
dateFrom
is inclusive and is used to retrieve transactions that are made from that date onwards. Transaction history is available up to 18 months from the date consent is given. The format of the parameter can be a date string in the format yyyy-MM-dd
, for example: 2024-09-01
, or it can be a UTC date time string based on ISO 8601, for example: 2024-09-01T12:00:00Z
. If a date-only value is provided, all transactions with a UTC
transactionDateTime
on or after that date will be included.dateTo
No
(default empty)
(default empty)
The
If a date-only value is provided, all transactions with a UTC
dateTo
is exclusive and is used to retrieve transactions that are made before that date. The format of the parameter can be a date string in the format yyyy-MM-dd
, for example: 2025-02-28
, or it can be a UTC date time string based on ISO 8601, for example: 2025-02-28T12:00:00Z
. If a date-only value is provided, all transactions with a UTC
transactionDateTime
before that date will be included.orderBy
No
(default
(default
transactionDateTime
)The
Allowed values are:
orderBy
is used to sort the data based on this field. Allowed values are:
- id
- accountNumber
- description
- transactionDateTime
- amount
- currency
- counterpartDescription
- counterpartAccountNumber
orderDirection
No
(default
(default
DESC
)The
Allowed values are:
orderDirection
is used specify the order direction. Allowed values are:
- DESC
- ASC
This request's response object is as explained in transactions.