Data types
Look up the allowed values of the API's enumerated attributes. Endpoint descriptions reference these tables.
Access rights
Values of the rights array in the consent access object. Each right unlocks the corresponding account data.
| Value | Description |
|---|---|
| ais | Read access to the accounts and their details. |
| accountDetails | Details of a specific account, such as identifiers, currency, and product. |
| balances | Balance data of the account. |
| transactions | Transaction history of the account. |
| trustedBeneficiaries | The account’s list of trusted beneficiaries. |
| ownerName | The account owner’s name. |
| psuName | The name of the customer (PSU) who authorises the consent. |
| initiatePayments | Permission to initiate payments from the account — a combined AIS and PIS consent. |
Consent types
Values of the consentType attribute. The type determines the required structure of the access object.
| Value | Description |
|---|---|
| global | Requests access to all available payment accounts. The rights apply to every account; no account references are sent. |
| aspspManaged | The customer selects the accessible accounts during authorisation at the bank. An empty rights array leaves the choice of rights to the bank. |
| detailed | Grants access to one or more specific payment accounts explicitly identified by the TPP via account identifiers. Access is limited to only the accounts specified. |
Consent statuses
Values of consentStatus over the consent lifecycle. A consent starts as received and becomes valid once the customer authorises it.
| Value | Description |
|---|---|
| received | Created and awaiting customer authorisation. |
| partiallyAuthorised | Some, but not all, required authorisations are complete (multi-user flows). |
| valid | Authorised and usable — pass its identifier in the Consent-ID header. |
| rejected | The customer declined the authorisation. |
| expired | The validTo date has passed; create a new consent to continue. |
| revokedByPsu | The customer withdrew the consent. |
| terminatedByTpp | You deleted the consent via the API. |
| replacedByTpp | Superseded by a newer consent you created. |
Balance types
Values of the balanceType attribute on a balance. They describe which entries and timing the balance reflects.
| Value | Description |
|---|---|
| closingBooked | Balance at the end of the last booking period, from booked entries only. |
| expected | Booked balance plus pending items — the amount expected to be available. |
| openingBooked | Balance at the start of the booking period, from booked entries only. |
| interimAvailable | Currently available balance, including pending items. |
| interimBooked | Current balance from booked entries only. |
| forwardAvailable | Forward-dated available balance, accounting for scheduled entries. |
| nonInvoiced | Outstanding amount not yet invoiced. |
Booking status
Values of the bookingStatus query parameter when listing transactions.
| Value | Description |
|---|---|
| booked | Transactions posted to the account. Always supported. |
| pending | Transactions authorised but not yet posted. |
| both | Booked and pending transactions together. |
| information | Standing orders and other account information, not actual transactions. |
| all | Booked, pending and information entries together. |
Account status
Values of the account status attribute.
| Value | Description |
|---|---|
| enabled | The account is open and usable. |
| deleted | The account is closed. |
| blocked | The account is temporarily blocked. |
Payment order statuses
Values of transactionStatus over a payment order lifecycle, using ISO 20022 codes.
| Value | Description |
|---|---|
| RCVD | Received by the bank. |
| PDNG | Pending. Further checks are in progress. |
| ACTC | Accepted. Authentication and validation are successful. |
| ACCP | Accepted. The customer profile check was also successful. |
| ACWC | Accepted, but a change was made, such as the execution date. |
| ACSP | Accepted and in settlement processing. |
| ACSC | Settlement on the debtor account has completed. |
| ACCC | Settlement on the creditor account has completed. |
| PATC | Partially authorised. Some authorisations are still missing. |
| PART | Partially accepted. Some transfers were rejected. Bulk payments only. |
| RJCT | Rejected. |
| CANC | Cancelled before execution. |
Authorisation statuses
Values of scaStatus while the customer authorises a payment or consent.
| Value | Description |
|---|---|
| received | The authorisation has been created at the bank. |
| psuIdentified | The customer has been identified. |
| psuAuthenticated | The customer has been authenticated. |
| scaMethodSelected | An SCA method has been selected. |
| started | The SCA routine has started. |
| unconfirmed | SCA finished. A confirmation command is still expected. |
| finalised | The authorisation completed successfully. Final. |
| failed | The authorisation failed. Final. |
| exempted | SCA was exempted. The authorisation is successful. Final. |