Consent API for V2.x (2.1)
Create, retrieve, and cancel the consents a PSU grants for account information and confirmation of funds. A consent records which data the TPP may access, how long the access lasts, and how often it can be used, and it moves through a defined set of statuses over its lifecycle.
Create funds consent
/v2/consents/funds-confirmations
Creates a consent resource at the ASPSP regarding confirmation of funds access to an account specified in this request.
Header parameters
| Header | Type | Description |
|---|---|---|
| PSU-User-Agent | string , optional |
The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Example: |
| PSU-Device-ID | string , optional |
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. Example: Format: uuid |
| PSU-Geo-Location | string , optional |
The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: Pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ |
| PSU-ID | string , optional |
Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation. Example: Allowed length: max: 140 |
| PSU-Corporate-ID | string , optional |
Might be mandated in the ASPSP's documentation. Only used in a corporate context. Example: Allowed length: max: 140 |
| Client-Redirect-URI | string , optional |
URI the transaction flow returns to after a redirect. Required for the redirect SCA approach. Example: Format: uri |
| 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 , required |
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 |
Body payload
| Field | Type | Description |
|---|---|---|
| access | oneOf , required |
The payment accounts the consent grants access to. See Consent types for how consent types differ. Exactly one of the consent-type-specific access schemas must apply, matching the request's |
| payments | array[object] , optional |
Account access rights for consentType "global". Only "ais" and "ownerName" allowed; account reference not used. |
| rights | array[string] , required |
Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: ais, ownerName |
| validTo | string , required |
This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date |
| cardNumber | string , optional |
Card Number of the card issued by the PIISP. Should be delivered if available. |
| consentType | string , required |
Only the consentTypes "detailed" and "aspspManaged" may be supported. Allowed values: global, detailed, aspspManaged, accountList |
| cardExpiryDate | string , optional |
Expiry date of the card issued by the PIISP Format: date |
| cardInformation | string , optional |
Additional explanation for the card product. |
| recurringIndicator | boolean , required |
|
| registrationInformation | string , optional |
Additional information about the registration process for the PSU, e.g. a reference to the TPP / PSU contract |
| Field | Type | Description |
|---|---|---|
| access | oneOf , required |
The payment accounts the consent grants access to. See Consent types for how consent types differ. Exactly one of the consent-type-specific access schemas must apply, matching the request's |
| payments | array[object] , optional |
Account access rights for consentType "detailed". Account reference is mandated; rights are taken from the detailed allowlist. |
| rights | array[string] , required |
Access rights requested for the payment account. Values are described in Access rights. Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName, initiatePayments |
| account | object , required |
Mandated for consentType "detailed": identifies the account these rights apply to. |
| iban | string , required |
International Bank Account Number. |
| validTo | string , required |
This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date |
| cardNumber | string , optional |
Card Number of the card issued by the PIISP. Should be delivered if available. |
| consentType | string , required |
Only the consentTypes "detailed" and "aspspManaged" may be supported. Allowed values: global, detailed, aspspManaged, accountList |
| cardExpiryDate | string , optional |
Expiry date of the card issued by the PIISP Format: date |
| cardInformation | string , optional |
Additional explanation for the card product. |
| recurringIndicator | boolean , required |
|
| registrationInformation | string , optional |
Additional information about the registration process for the PSU, e.g. a reference to the TPP / PSU contract |
| Field | Type | Description |
|---|---|---|
| access | oneOf , required |
The payment accounts the consent grants access to. See Consent types for how consent types differ. Exactly one of the consent-type-specific access schemas must apply, matching the request's |
| payments | array[object] , optional |
Account access rights for consentType "aspspManaged". No account reference; rights from aspspManaged allowlist; empty rights allowed. |
| rights | array[string] , required |
Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName |
| validTo | string , required |
This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date |
| cardNumber | string , optional |
Card Number of the card issued by the PIISP. Should be delivered if available. |
| consentType | string , required |
Only the consentTypes "detailed" and "aspspManaged" may be supported. Allowed values: global, detailed, aspspManaged, accountList |
| cardExpiryDate | string , optional |
Expiry date of the card issued by the PIISP Format: date |
| cardInformation | string , optional |
Additional explanation for the card product. |
| recurringIndicator | boolean , required |
|
| registrationInformation | string , optional |
Additional information about the registration process for the PSU, e.g. a reference to the TPP / PSU contract |
Responses
Select a status code to see the structure and an example of the response.
| Field | Type | Description |
|---|---|---|
| consentId | string , required |
Identification of the consent resource as it is used in the API structure |
| psuMessage | string , optional |
Text to be displayed to the PSU. |
| consentStatus | string , required |
Status of the consent. Statuses are described in Consent statuses. Allowed values: received, rejected, partiallyAuthorised, valid, revokedByPsu, expired, terminatedByTpp, replacedByTpp |
| _links | object , required |
A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation Response messages. These links will also be contained in the related Open API files. Remark: All links can be relative or full links, to be decided by the ASPSP. |
| self | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| status | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| scaOAuth | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| scaStatus | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| scaRedirect | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmation | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisation | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| encryptionCertificates | array[object] , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | 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 |
JSON path to the request field the message relates to, when applicable. |
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Whether the message is an error or a warning. Allowed values: ERROR, WARNING |
| _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 |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| 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 |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| 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 |
JSON path to the request field the message relates to, when applicable. |
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Whether the message is an error or a warning. Allowed values: ERROR, WARNING |
| _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 |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| 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 |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| 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 |
JSON path to the request field the message relates to, when applicable. |
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Whether the message is an error or a warning. Allowed values: ERROR, WARNING |
| _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 |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| 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 |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| 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 |
JSON path to the request field the message relates to, when applicable. |
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Whether the message is an error or a warning. Allowed values: ERROR, WARNING |
| _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 |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| 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 |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|