Account Information Service (2.3)
Retrieve a PSU's account information — account details, balances, transactions, and statements — for the accounts covered by a valid consent.
List transactions
/v2/accounts/{account-id}/transactions
Returns an account's transactions — booked or pending — for the requested period.
Path parameters
| Parameter | Type | Description |
|---|---|---|
| account-id | string , required |
Identifier of the account, returned as Example: Allowed length: max: 70 |
Query parameters
| Parameter | Type | Description |
|---|---|---|
| dateFrom | string , optional |
Start date of the transaction list, inclusive. Example: Format: date |
| dateTo | string , optional |
End date of the transaction list, inclusive. Defaults to today. Example: Format: date |
| bookingStatus | string , required |
Which transactions to return. Allowed values: booked, pending, both Example: |
| withBalance | boolean , optional |
Include the account's balances in the response, when the consent and bank allow. Example: |
Header parameters
| Header | Type | Description |
|---|---|---|
| Digest | string , optional |
Integrity hash of the request body in the form Example: |
| 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: 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: Format: ipv4 |
| Consent-ID | string , required |
Identifier of the consent that authorises this access, as returned when the consent was created. Example: Allowed length: max: 70 |
Responses
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. |
| iban | string , required |
International Bank Account Number. |
| balances | array[object] , optional |
A list of balances regarding this account, e.g. the current balance, the last booked balance. |
| balanceType | string , required |
The type of balance. Values are described in Balance types. Allowed values: interimAvailable |
| balanceAmount | object , required |
The balance amount and its currency. |
| amount | string , required |
Amount with decimal digits and a dot as the decimal separator. Example: Pattern: ^-?[0-9]{1,14}(\.[0-9]{1,3})?$ |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| transactions | object , optional |
The account's transactions, split into booked and pending. |
| booked | array[object] , optional |
Shall be contained if bookingStatus parameter is set to "booked" or "both". |
| creditor | object , required |
Name and, where available, identification of the creditor (on a debit). |
| name | string , required |
Name of the party. |
| valueDate | string , required |
Date the funds became available for a credit, or were taken for a debit. Format: date |
| transactionId | string , optional |
Identifier used to request the details of this transaction. |
| creditorAccount | object , required |
The creditor's account. |
| iban | string , required |
International Bank Account Number. |
| transactionAmount | object , required |
The transaction amount and its currency. Negative for debits. |
| amount | string , required |
Amount with decimal digits and a dot as the decimal separator. Example: Pattern: ^-?[0-9]{1,14}(\.[0-9]{1,3})?$ |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| remittanceInformationUnstructured | array[string] , optional |
Free-text remittance information. |
| _links | object , optional |
Link to this transaction's details. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| pending | array[object] , optional |
Not contained if the bookingStatus parameter is set to "booked". |
| creditor | object , required |
Name and, where available, identification of the creditor (on a debit). |
| name | string , required |
Name of the party. |
| valueDate | string , required |
Date the funds became available for a credit, or were taken for a debit. Format: date |
| transactionId | string , optional |
Identifier used to request the details of this transaction. |
| creditorAccount | object , required |
The creditor's account. |
| iban | string , required |
International Bank Account Number. |
| transactionAmount | object , required |
The transaction amount and its currency. Negative for debits. |
| amount | string , required |
Amount with decimal digits and a dot as the decimal separator. Example: Pattern: ^-?[0-9]{1,14}(\.[0-9]{1,3})?$ |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| remittanceInformationUnstructured | array[string] , optional |
Free-text remittance information. |
| _links | object , optional |
Link to this transaction's details. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| _links | object , required |
Links to the account, its balances and transactions, and pagination. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| _links | object , optional |
Links to the account, its balances and transactions, and pagination. |
| download | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). Allowed values: FORMAT_ERROR, PARAMETER_NOT_CONSISTENT, PARAMETER_NOT_SUPPORTED, SERVICE_INVALID, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED, RESOURCE_BLOCKED, TIMESTAMP_INVALID, PERIOD_INVALID, SCA_METHOD_UNKNOWN, SCA_INVALID, CONSENT_TYPE_NOT_SUPPORTED, SESSIONS_NOT_SUPPORTED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). Allowed values: CERTIFICATE_INVALID, ROLE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, PSU_CREDENTIALS_INVALID, CORPORATE_ID_INVALID, CONSENT_INVALID, CONSENT_EXPIRED, TOKEN_UNKNOWN, TOKEN_INVALID, TOKEN_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). Allowed values: SERVICE_BLOCKED, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). Allowed values: SERVICE_INVALID Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
Link to this resource. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|