openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines - Extended Payment Initiation Service (2.1)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

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.

Get authorisation status

GET /v2/{resource-path}/{resourceId}/{authorisation-category}/{authorisationId}

Checks the SCA status of an authorisation or cancellation authorisation sub-resource.

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: `consents/account-access`
resourceId	string , required	Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource. Example: `1234-resource-567` Allowed length: max: 70
authorisation-category	string , required	The following two categories are supported: * authorisations: used in case of an authorisation of the related business transaction. * cancellation-authorisations: used in case of the cancellation authorisation of the related business transaction. Used only if applicable to the addressed {service} Allowed values: authorisations, cancellation-authorisations Example: `authorisations`
authorisationId	string , required	Resource identification of the related SCA. Example: `123auth456` Allowed length: max: 70

Header parameters

Header	Type	Description
Digest	string , optional	Integrity hash of the request body in the form `SHA-256=<base64>`. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built. Example: `SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=`
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: `99391c7e-ad88-49ec-a2ad-99ddcb1f7721` Format: uuid

Responses

Select a status code to see the structure and an example of the response.

Field	Type	Description
psuName	string , optional	Name of the PSU (Usage is following the mandate resulting from EBA Q&A 2020_5165). In case of a corporate account, this might be the person acting on behalf of the corporate.
scaStatus	string , required	This data element is containing information about the status of the SCA method applied. Allowed values: received, psuIdentified, psuAuthenticated, scaMethodSelected, started, unconfirmed, finalised, failed, exempted
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	object , required	See document "openFinance API Framework Data Dictionary", section "Message Code" for more details.
path	string , optional	Path of the element of the request message which provoked the error message, if applicable
text	string , optional	Additional explaining text.
category	string , required	Only "ERROR" or "WARNING" permitted
_links	object , optional	Should refer to next steps if the problem can be resolved via the interface e.g. for re-submission of credentials.
scaStatus	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: `FORMAT_ERROR`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` 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: `CERTIFICATE_INVALID`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` 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: `SERVICE_BLOCKED`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` 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: `SERVICE_INVALID`
path	string , optional
text	string , optional	Example: `Text, maximum of 500 characters.` 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

curl -X GET \
  "https://openfinance.saltedge.com/test_bank/api/v2/{resource-path}/{resourceId}/{authorisation-category}/{authorisationId}" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721"

{
  "psuName": "Text, maximum of 140 characters.",
  "scaStatus": "received",
  "apiClientMessages": [
    {
      "code": {},
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "scaStatus": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "FORMAT_ERROR",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "CERTIFICATE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_BLOCKED",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "string"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}