openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines - Extended Payment Initiation Service (2.1)
The specific function in the Extended Payment Initiation Services is to make the initiation phase more flexible, i.e. * separate authorisation and actual initiation processes as well as * unbundle risk management functionality from the actual payment initiation, but already apply e.g. limit and balance checks during the authorisation and hence * potentially secure the future payment initiation in addition.
Update debtor account
/v2/{resource-path}/{resourceId}
The following method is used to update a payment related resource by an account which is associated to a PSU, and which needs to be received from the ASPSP first in the response of the "Update PSU Data with Authentication Request". Remark: This procedure might be offered by the ASPSP in decoupled or embedded SCA channels to support "noManualIbanEntry" requirements from regulators for payment initiation.
Path parameters
| Parameter | Type | Description |
|---|---|---|
| resource-path | string , required |
This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where * {service} stands for the service type of the related business transaction, e.g. /payments or /consents source. * {product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents. Example: |
| resourceId | string , required |
Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource. Example: Allowed length: max: 70 |
Header parameters
| Header | Type | Description |
|---|---|---|
| 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 |
| PSU-IP-Port | string , optional |
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: |
| PSU-Accept | string , optional |
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: |
| PSU-Accept-Charset | string , optional |
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: |
| PSU-Accept-Encoding | string , optional |
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: |
| PSU-Accept-Language | string , optional |
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: |
| PSU-User-Agent | string , optional |
The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Example: |
| PSU-Http-Method | string , optional |
HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE Allowed values: GET, POST, PUT, PATCH, DELETE 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} |
| 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 |
| Body-Sig-Profile | string , optional |
Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed. Allowed values: JAdES_JS, XAdES, EMV_AC, EUDIW Example: |
| Body-Enc-Profile | string , optional |
Indicates the encryption profile used for the encryption of (parts of) the body. Allowed values: JWE_CS, XML_ENC Example: |
| Body-Enc-List | string , optional |
Contains a List of names of data elements/ attributes of the body which contain encrypted information Example: |
Body payload
| Field | Type | Description |
|---|---|---|
| debtorAccount | object , required |
The resourceId of the account as provided in the "Update PSU Data with Authentication Request" response shall be used as the technical account reference. |
| resourceId | string , optional |
To be used in authorisation processes, when updating a resource by an account. Format: uuid |
Responses
Select a status code to see the structure and an example of the response.
| Field | Type | Description |
|---|---|---|
| psuMessage | string , optional |
Text to be displayed to the PSU. |
| scaMethods | array[object] , optional |
Might be contained, if several authentication methods are available. (name, type) |
| name | string , required |
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. |
| explanation | string , optional |
detailed information about the SCA method for the PSU |
| authenticationType | string , required |
Type of the authentication method. Allowed values: SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP |
| authenticationVersion | string , optional |
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP's documentation. |
| authenticationMethodId | string , required |
An identification provided by the ASPSP for the later identification of the authentication method selection. |
| challengeData | object , optional |
Challenge data might be contained, if only one authentication method is available, and if the Embedded SCA approach is chosen by the ASPSP. |
| data | array[string] , optional |
A collection of challenge data |
| image | string , optional |
PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method. |
| imageLink | string , optional |
A link where the ASPSP will provides the challenge image for the TPP. |
| otpFormat | string , optional |
The format type of the OTP to be typed in. The admitted values are "characters" or "integer". |
| otpMaxLength | integer , optional |
The maximal length for the OTP to be typed in by the PSU. |
| additionalInformation | string , optional |
Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU. |
| chosenScaMethod | object , optional |
A definition of the provided SCA method is contained, if only one authentication method is available, and if the Embedded SCA approach is chosen by the ASPSP. |
| name | string , required |
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. |
| explanation | string , optional |
detailed information about the SCA method for the PSU |
| authenticationType | string , required |
Type of the authentication method. Allowed values: SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP |
| authenticationVersion | string , optional |
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP's documentation. |
| authenticationMethodId | string , required |
An identification provided by the ASPSP for the later identification of the authentication method selection. |
| _links | object , optional |
A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. Remark: All links can be relative or full links, to be decided by the ASPSP. |
| 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 |
|
| transactionFees | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| authoriseTransaction | 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 |
|
| selectAuthenticationMethod | 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 |
The error code identifying the specific problem. 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 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 |
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 |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| 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 |
The error code identifying the specific problem. Allowed values: CERTIFICATE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, ROLE_INVALID, 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 |
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 |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| 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 |
The error code identifying the specific problem. 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 |
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 |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| 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 |
The error code identifying the specific problem. 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 |
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 |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| 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 |
|