Implements PIS/PIIS functions
Paths
/v1/{payment-service}/{payment-product}
initiatePayment
This method is used to initiate a payment at the ASPSP.
Variants of Payment Initiation Requests
This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
There are the following payment products:
- Payment products with payment information in JSON format:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- Payment products with payment information in pain.001 XML format:
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Furthermore the request body depends on the payment-service
- payments: A single payment initiation request.
bulk-payments: A collection of several payment iniatiation requests.
In case of a pain.001 message there are more than one payments contained in the *pain.001 message.
In case of a JSON there are several JSON payment blocks contained in a joining list.
- periodic-payments: Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId} with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.
This is the first step in the API to initiate the related recurring/periodic payment.
Single and mulitilevel SCA Processes
The Payment Initiation Requests are independent from the need of one ore multilevel SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation, i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the response message of a Payment Initation Request for a payment, where multiple authorisations are needed. Also if any data is needed for the next action, like selecting an SCA method is not supported in the response, since all starts of the multiple authorisations are fully equal. In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}ID of the request, unique to the call, as determined by the initiating party.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
{
"enum": [
"true",
"false"
]
}URI of the TPP, where the transaction flow shall be redirected to after a Redirect.
Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.
Remark for Future: This field might be changed to mandatory in the next version of the specification.
If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.
If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
{
"enum": [
"true",
"false"
]
}If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available.
If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment.
This parameter might be ignored by the ASPSP.
{
"enum": [
"true",
"false"
]
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}payment parameters
{
"schema": {
"type": "object"
}
}application/x-www-form-urlencoded
CREATED
{
"schema": {
"type": "object"
},
"examples": {
"application\/json": "{\"description\":\"Response in case of a redirect with an implicitly created authorisation sub-resource\",\"value\":{\"transactionStatus\":\"RCVD\",\"paymentId\":\"1234-wertiq-983\",\"_links\":{\"scaRedirect\":{\"href\":\"https:\/\/www.testbank.com\/asdfasdfasdf\"},\"self\":{\"href\":\"\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983\"},\"status\":{\"href\":\"\/v1\/payments\/1234-wertiq-983\/status\"},\"scaStatus\":{\"href\":\"\/v1\/payments\/1234-wertiq-983\/authorisations\/123auth456\"}}}}"
},
"headers": {
"X-Request-ID": {
"type": "string",
"default": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
},
"Location": {
"type": "string"
},
"ASPSP-SCA-Approach": {
"type": "string",
"default": "EMBEDDED"
}
}
}Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/{payment-service}/{payment-product}/{paymentId}
getPaymentInformation
Returns the content of a payment object
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}OK
{
"schema": {
"type": "object"
},
"headers": {
"X-Request-ID": {
"type": "string",
"default": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}
}
}Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
cancelPayment
This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message.
Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day).
The response to this DELETE command will tell the TPP whether the
- access method was rejected
- access method was successful, or
- access method is generally applicable, but further authorisation processes are needed.
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/d/{payment-service}/{payment-product}/{paymentId}
getPaymentInformation
Returns the content of a payment object
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Client ID of the PSU in the ASPSP client interface
OK
{
"schema": {
"type": "object"
},
"headers": {
"X-Request-ID": {
"type": "string",
"default": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}
}
}Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
cancelPayment
This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message.
Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day).
The response to this DELETE command will tell the TPP whether the
- access method was rejected
- access method was successful, or
- access method is generally applicable, but further authorisation processes are needed.
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Client ID of the PSU in the ASPSP client interface
No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/{payment-service}/{payment-product}/{paymentId}/status
getPaymentInitiationStatus
Check the transaction status of a payment initiation.
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/d/{payment-service}/{payment-product}/{paymentId}/status
getPaymentInitiationStatus
Check the transaction status of a payment initiation.
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
The following payment products are supported:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
- pain.001-sepa-credit-transfers
- pain.001-instant-sepa-credit-transfers
- pain.001-target-2-payments
- pain.001-cross-border-credit-transfers
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.
Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
{
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}Resource identification of the generated payment initiation resource.
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}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 need to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}"
}Client ID of the PSU in the ASPSP client interface
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}
/v1/funds-confirmations
checkAvailabilityOfFunds
Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively
Pentru operatia de confirmare fonduri in cont
ID of the request, unique to the call, as determined by the initiating party.
Request body for a confirmation of funds request.
This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
/v1/d/funds-confirmations
checkAvailabilityOfFunds
Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively
ID of the request, unique to the call, as determined by the initiating party.
Request body for a confirmation of funds request.
This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Client ID of the PSU in the ASPSP client interface
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Service Unavailable
Internal Server Error
Definitions
The transaction status is filled with codes of the ISO 20022 data table:
- 'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed.
- 'ACCP': 'AcceptedCustomerProfile' - Preceding check of technical validation was successful. Customer profile check was also successful.
'ACSC': 'AcceptedSettlementCompleted' - Settlement on the debtor�s account has been completed.
Usage: this can be used by the first agent to report to the debtor that the transaction has been completed.
Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.
- 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
- 'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful.
- 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent.
- 'ACWP': 'AcceptedWithoutPosting' - Payment instruction included in the credit transfer is accepted without being posted to the creditor customer�s account.
- 'RCVD': 'Received' - Payment initiation has been received by the receiving agent.
- 'PDNG': 'Pending' - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
- 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.
- 'CANC': 'Cancelled' Payment initiation has been cancelled before execution Remark: This codeis accepted as new code by ISO20022.
- 'ACFC': 'AcceptedFundsChecked' - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive . Remark: This code is accepted as new code by ISO20022.
- 'PATC': 'PartiallyAcceptedTechnical' Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful. Remark: This code is accepted as new code by ISO20022.
- 'PART': 'PartiallyAccepted' - A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.
{
"title": "transactionStatus",
"example": "ACCC",
"type": "string",
"enum": [
"ACCC",
"ACCP",
"ACSC",
"ACSP",
"ACTC",
"ACWC",
"ACWP",
"RCVD",
"PDNG",
"RJCT",
"CANC",
"ACFC",
"PATC",
"PART"
]
}
The transaction status is filled with codes of the ISO 20022 data table. Only the codes RCVD, PATC, ACTC, ACWC and RJCT are used:
- 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
- 'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful.
- 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent.
- 'RCVD': 'Received' - Payment initiation has been received by the receiving agent.
- 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.
{
"title": "transactionStatus_SBS",
"example": "ACSC",
"type": "string",
"enum": [
"ACSC",
"ACTC",
"ACWC",
"RCVD",
"RJCT"
]
}
This data element is containing information about the status of the SCA method applied.
The following codes are defined for this data type.
- 'received': An authorisation or cancellation-authorisation resource has been created successfully.
- 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified.
- 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.
- 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'.
- 'started': The addressed SCA routine has been started.
- 'finalised': The SCA routine has been finalised successfully.
- 'failed': The SCA routine failed
- 'exempted': SCA was exempted for the related transaction, the related authorisation is successful.
{
"title": "scaStatus",
"example": "received",
"type": "string",
"enum": [
"received",
"psuIdentified",
"psuAuthenticated",
"scaMethodSelected",
"started",
"finalised",
"failed",
"exempted"
]
}
This is the overall lifecycle status of the consent.
Valid values are:
- 'received': The consent data have been received and are technically correct. The data is not authorised yet.
- 'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.
- 'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.
- 'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.
- 'expired': The consent expired.
- 'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.
The ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface and has to be added to this API definition as well.
{
"title": "consentStatus",
"example": "received",
"type": "string",
"enum": [
"received",
"rejected",
"valid",
"revokedByPsu",
"expired",
"terminatedByTpp"
]
}
Authentication Object
{
"title": "authenticationObject",
"type": "object",
"properties": {
"authenticationType": {
"$ref": "#\/definitions\/authenticationType"
},
"authenticationVersion": {
"description": "Depending on the \"authenticationType\".\nThis version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.\nThis version can be referred to in the ASPSP?s documentation.",
"type": "string"
},
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID",
"type": "string",
"maxLength": 35
},
"name": {
"description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.\nAlternatively this could be a description provided by the ASPSP like \"SMS OTP on phone +49160 xxxxx 28\".\nThis name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.",
"example": "SMS OTP on phone +49160 xxxxx 28",
"type": "string"
},
"explanation": {
"description": "Detailed information about the SCA method for the PSU.",
"example": "Detailed information about the SCA method for the PSU.",
"type": "string"
}
},
"required": [
"authenticationType",
"authenticationMethodId"
]
}
Type of the authentication method.
More authentication types might be added during implementation projects and documented in the ASPSP documentation.
- 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.
- 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU.
- 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU.
- 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.
{
"title": "authenticationType",
"example": "SMS_OTP",
"type": "string",
"enum": [
"SMS_OTP",
"CHIP_OTP",
"PHOTO_OTP",
"PUSH_OTP"
]
}
JSON Body of a establish signing basket request. The body shall contain at least one entry.
{
"title": "signingBasket",
"example": {
"description": "JSON Body of a signing basket request",
"value": {
"paymentIds": [
"123qwert456789",
"12345qwert7899"
]
}
},
"type": "object",
"properties": {
"paymentIds": {
"description": "A list of paymentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"consentIds": {
"description": "A list of consentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
}
}
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
{
"title": "challengeData",
"type": "object",
"properties": {
"image": {
"description": "PNG data (max. 512 kilobyte) to be displayed to the PSU,\nBase64 encoding, cp. [RFC4648].\nThis attribute is used only, when PHOTO_OTP or CHIP_OTP\nis the selected SCA method.",
"type": "string"
},
"data": {
"description": "String challenge data",
"type": "string"
},
"imageLink": {
"description": "A link where the ASPSP will provides the challenge image for the TPP.",
"type": "string"
},
"otpMaxLength": {
"description": "The maximal length for the OTP to be typed in by the PSU.",
"type": "integer",
"format": "int32"
},
"otpFormat": {
"$ref": "#\/definitions\/OtpFormat"
},
"additionalInformation": {
"description": "Additional explanation for the PSU to explain\ne.g. fallback mechanism for the chosen SCA method.\nThe TPP is obliged to show this to the PSU.",
"type": "string"
}
}
}
Link to a resource
{
"title": "hrefType",
"type": "object",
"properties": {
"href": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
An array of all authorisationIds
{
"title": "authorisations",
"type": "object",
"properties": {
"authorisationIds": {
"description": "An array of all authorisationIds",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"authorisationIds"
]
}
Reference to an account by either
- IBAN, of a payment accounts, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
{
"title": "accountReference",
"type": "object",
"properties": {
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier\n\nThis data element can be used in the body of the Consent Request\n Message for retrieving Account access Consent from this Account. This\n data elements is used for payment Accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN). \n \n Identifier used nationally by financial institutions, i.e., in individual countries, \n generally as part of a National Account Numbering Scheme(s), \n which uniquely identifies the account of a customer.",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"pan": {
"description": "Primary Account Number according to ISO\/IEC 7812.",
"example": "5409050000000000",
"type": "string",
"maxLength": 35
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
}
}
}
The following balance types are defined:
"closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.
For card-accounts, this is composed of
- invoiced, but not yet paid entries
"expected": Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.
For card accounts, this is composed of
- invoiced, but not yet paid entries,
- not yet invoiced but already booked entries and
- pending items (not yet booked)
"authorised": The expected balance together with the value of a pre-approved credit line the ASPSP makes permanently available to the user.
For card-accounts:
"money to spend with the value of a pre-approved credit limit on the card account"
"openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
"interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
For card-accounts, this is composed of
- invoiced, but not yet paid entries,
- not yet invoiced but already booked entries
- "forwardAvailable": Forward available balance of money that is at the disposal of the account owner on the date specified.
- "nonInvoiced": Only for card accounts, to be checked yet.
{
"title": "balanceType",
"example": "closingBooked",
"type": "string",
"enum": [
"closingBooked",
"expected",
"authorised",
"openingBooked",
"interimAvailable",
"interimBooked",
"forwardAvailable",
"nonInvoiced"
]
}
Requested access services for a consent.
{
"title": "accountAccess",
"type": "object",
"properties": {
"accounts": {
"description": "Is asking for detailed account information. \n\nIf the array is empty, the TPP is asking for an accessible account list. \nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for balances or transactions shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"balances": {
"description": "Is asking for balances of the addressed accounts.\n\nIf the array is empty, the TPP is asking for the balances of all accessible account lists. \nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for accounts or transactions shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"transactions": {
"description": "Is asking for transactions of the addressed accounts. \n\nIf the array is empty, the TPP is asking for the transactions of all accessible account lists. \nThis may be restricted in a PSU\/ASPSP authorization dialogue.\nIf the array is empty, also the arrays for accounts or balances shall be empty, if used.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"availableAccounts": {
"$ref": "#\/definitions\/AvailableAccounts"
},
"allPsd2": {
"$ref": "#\/definitions\/AllPsd2"
}
}
}
Account status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
{
"title": "accountStatus",
"example": "enabled",
"type": "string",
"enum": [
"enabled",
"deleted",
"blocked"
]
}
The ASPSP shall give at least one of the account reference identifiers:
- iban
- bban
- pan
- maskedPan
- msisdn If the account is a multicurrency account currency code in "currency" is set to "XXX".
{
"title": "accountDetails",
"type": "object",
"properties": {
"resourceId": {
"description": "This shall be filled, if addressable resource are created by the ASPSP on the \/accounts or \/card-accounts endpoint.",
"type": "string"
},
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier\n\nThis data element can be used in the body of the Consent Request\n Message for retrieving Account access Consent from this Account. This\n data elements is used for payment Accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN). \n \n Identifier used nationally by financial institutions, i.e., in individual countries, \n generally as part of a National Account Numbering Scheme(s), \n which uniquely identifies the account of a customer.",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account given by the bank or the PSU in online-banking.",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"cashAccountType": {
"description": "ExternalCashAccountType1Code from ISO 20022.",
"type": "string"
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"bic": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"linkedAccounts": {
"description": "Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.",
"type": "string",
"maxLength": 70
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP\n - characteristics of the account\n - characteristics of the relevant card",
"type": "string",
"maxLength": 140
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountDetails"
}
},
"required": [
"currency"
]
}
Card account details
{
"title": "cardAccountDetails",
"type": "object",
"properties": {
"resourceId": {
"description": "This is the data element to be used in the path when retrieving data from a dedicated account.\nThis shall be filled, if addressable resource are created by the ASPSP on the \/card-accounts endpoint.",
"type": "string"
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account given by the bank or the PSU in online-banking.",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP\n - characteristics of the account\n - characteristics of the relevant card",
"type": "string",
"maxLength": 140
},
"creditLimit": {
"$ref": "#\/definitions\/amount"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountDetails"
}
},
"required": [
"maskedPan",
"currency"
]
}
List of accounts with details.
{
"title": "accountList",
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/accountDetails"
}
}
},
"required": [
"accounts"
]
}
List of card accounts with details.
{
"title": "cardAccountList",
"type": "object",
"properties": {
"cardAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/cardAccountDetails"
}
}
},
"required": [
"cardAccounts"
]
}
JSON based account report. This account report contains transactions resulting from the query parameters.
'booked' shall be contained if bookingStatus parameter is set to "booked" or "both".
'pending' is not contained if the bookingStatus parameter is set to "booked".
{
"title": "accountReport",
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAccountReport"
}
},
"required": [
"_links"
]
}
JSON based card account report.
This card account report contains transactions resulting from the query parameters.
{
"title": "cardAccountReport",
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"_links": {
"$ref": "#\/definitions\/_linksCardAccountReport"
}
},
"required": [
"booked",
"_links"
]
}
Transaction details
{
"title": "transactionDetails",
"type": "object",
"properties": {
"transactionId": {
"description": "the Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. \nIf this data attribute is provided this shows that the AIS can get access on more details about this \ntransaction using the GET Transaction Details Request",
"type": "string"
},
"entryReference": {
"description": "Is the identification of the transaction as used e.g. for reference for deltafunction on application level. \nThe same identification as for example used within camt.05x messages.",
"type": "string",
"maxLength": 35
},
"endToEndId": {
"description": "Unique end to end identity.",
"type": "string",
"maxLength": 35
},
"mandateId": {
"description": "Identification of Mandates, e.g. a SEPA Mandate ID.",
"type": "string",
"maxLength": 35
},
"checkId": {
"description": "Identification of a Cheque.",
"type": "string",
"maxLength": 35
},
"creditorId": {
"description": "Identification of Creditors, e.g. a SEPA Creditor ID.",
"type": "string",
"maxLength": 35
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"valueDate": {
"description": "The Date at which assets become available to the account owner in case of a credit.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"currencyExchange": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/reportExchangeRate"
}
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateCreditor": {
"description": "Ultimate Creditor",
"example": "Ultimate Creditor",
"type": "string",
"maxLength": 70
},
"debtorName": {
"description": "Debtor Name",
"example": "Debtor Name",
"type": "string",
"maxLength": 70
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateDebtor": {
"description": "Ultimate Debtor",
"example": "Ultimate Debtor",
"type": "string",
"maxLength": 70
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"remittanceInformationStructured": {
"description": "Reference as contained in the structured remittance reference structure (without the surrounding XML structure).\n\nDifferent from other places the content is containt in plain form not in form of a structered field.",
"type": "string",
"maxLength": 140
},
"additionalInformation": {
"description": "Might be used by the ASPSP to transport additional transaction related information to the PSU.",
"type": "string",
"maxLength": 512
},
"purposeCode": {
"$ref": "#\/definitions\/purposeCode"
},
"bankTransactionCode": {
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022. \n\nThis code type is concatenating the three ISO20022 Codes \n * Domain Code, \n * Family Code, and \n * SubFamiliy Code \nby hyphens, resulting in �DomainCode�-�FamilyCode�-�SubFamilyCode�.",
"example": "PMNT-RCDT-ESCT",
"type": "string"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g. \nfor MT94x based transaction reports.",
"type": "string",
"maxLength": 35
},
"_links": {
"$ref": "#\/definitions\/_linksTransactionDetails"
}
},
"required": [
"transactionAmount"
]
}
Card transaction information
{
"title": "cardTransaction",
"type": "object",
"properties": {
"cardTransactionId": {
"description": "Unique end to end identity.",
"type": "string",
"maxLength": 35
},
"terminalId": {
"description": "Identification of the Terminal, where the card has been used.",
"type": "string",
"maxLength": 35
},
"transactionDate": {
"description": "Date of the actual card transaction",
"type": "string",
"format": "date"
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"currencyExchange": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/reportExchangeRate"
}
},
"originalAmount": {
"$ref": "#\/definitions\/amount"
},
"markupFee": {
"$ref": "#\/definitions\/amount"
},
"markupFeePercentage": {
"example": "0.3",
"type": "string"
},
"cardAcceptorId": {
"type": "string",
"maxLength": 35
},
"cardAcceptorAddress": {
"$ref": "#\/definitions\/address"
},
"merchantCategoryCode": {
"description": "Merchant category code",
"type": "string",
"minLength": 4,
"maxLength": 4
},
"maskedPAN": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"transactionDetails": {
"type": "string",
"maxLength": 140
},
"invoiced": {
"type": "boolean"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g. \nfor MT94x based transaction reports.",
"type": "string",
"maxLength": 35
}
},
"required": [
"transactionAmount"
]
}
Exchange Rate
{
"title": "reportExchangeRate",
"type": "object",
"properties": {
"sourceCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"exchangeRate": {
"type": "string"
},
"unitCurrency": {
"type": "string"
},
"targetCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"quotationDate": {
"type": "string",
"format": "date"
},
"contractIdentification": {
"type": "string"
}
},
"required": [
"sourceCurrency",
"exchangeRate",
"unitCurrency",
"targetCurrency",
"quotationDate"
]
}
Exchange Rate
{
"title": "paymentExchangeRate",
"type": "object",
"properties": {
"unitCurrency": {
"type": "string"
},
"exchangeRate": {
"type": "string"
},
"contractIdentification": {
"type": "string"
},
"rateType": {
"$ref": "#\/definitions\/RateType"
}
}
}
A single balance element
{
"title": "balance",
"type": "object",
"properties": {
"balanceAmount": {
"$ref": "#\/definitions\/amount"
},
"balanceType": {
"$ref": "#\/definitions\/balanceType"
},
"lastChangeDateTime": {
"description": "This data element might be used to indicate e.g. with the expected or booked balance that no action is known \non the account, which is not yet booked.",
"type": "string",
"format": "date-time"
},
"referenceDate": {
"description": "Reference date of the balance",
"type": "string",
"format": "date"
},
"lastCommittedTransaction": {
"description": "\"entryReference\" of the last commited transaction to support the TPP in identifying whether all \nPSU transactions are already known.",
"type": "string",
"maxLength": 35
}
},
"required": [
"balanceAmount",
"balanceType"
]
}
{
"title": "address",
"example": {
"street": "rue blue",
"buildingnNumber": "89",
"city": "Paris",
"postalCode": "75000",
"country": "FR"
},
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"description": "ISO 3166 ALPHA2 country code",
"example": "SE",
"type": "string",
"pattern": "[A-Z]{2}"
}
},
"required": [
"country"
]
}
{
"title": "amount",
"example": {
"currency": "EUR",
"amount": "123"
},
"type": "object",
"properties": {
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n * 1056\n * 5768.2\n * -1.50\n * 5877.78",
"example": "5877.78",
"type": "string",
"pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
}
},
"required": [
"currency",
"amount"
]
}
Charge Bearer. ChargeBearerType1Code from ISO20022
{
"title": "chargeBearer",
"example": "DEBT",
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
]
}
Structured remittance information
{
"title": "remittanceInformationStructured",
"type": "object",
"properties": {
"reference": {
"type": "string",
"maxLength": 35
},
"referenceType": {
"type": "string",
"maxLength": 35
},
"referenceIssuer": {
"type": "string",
"maxLength": 35
}
},
"required": [
"reference"
]
}
ExternalPurpose1Code from ISO 20022.
Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
{
"title": "purposeCode",
"example": "BKDF",
"type": "string",
"enum": [
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"CBLK",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDOC",
"CDQC",
"ETUP",
"FCOL",
"MTUP",
"ACCT",
"CASH",
"COLL",
"CSDB",
"DEPT",
"INTC",
"LIMA",
"NETT",
"BFWD",
"CCIR",
"CCPC",
"CCPM",
"CCSM",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"EQPT",
"EQUS",
"EXPT",
"EXTD",
"FIXI",
"FWBC",
"FWCC",
"FWSB",
"FWSC",
"MARG",
"MBSB",
"MBSC",
"MGCC",
"MGSC",
"OCCC",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"REPO",
"RPBC",
"RPCC",
"RPSB",
"RPSC",
"RVPO",
"SBSC",
"SCIE",
"SCIR",
"SCRP",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SWBC",
"SWCC",
"SWPT",
"SWSB",
"SWSC",
"TBAS",
"TBBC",
"TBCC",
"TRCP",
"AGRT",
"AREN",
"BEXP",
"BOCE",
"COMC",
"CPYR",
"GDDS",
"GDSV",
"GSCB",
"LICF",
"MP2B",
"POPE",
"ROYA",
"SCVE",
"SERV",
"SUBS",
"SUPP",
"TRAD",
"CHAR",
"COMT",
"MP2P",
"ECPG",
"ECPR",
"ECPU",
"EPAY",
"CLPR",
"COMP",
"DBTC",
"GOVI",
"HLRP",
"HLST",
"INPC",
"INPR",
"INSC",
"INSU",
"INTE",
"LBRI",
"LIFI",
"LOAN",
"LOAR",
"PENO",
"PPTI",
"RELG",
"RINP",
"TRFD",
"FORW",
"FXNT",
"ADMG",
"ADVA",
"BCDM",
"BCFG",
"BLDM",
"BNET",
"CBFF",
"CBFR",
"CCRD",
"CDBL",
"CFEE",
"CGDD",
"CORT",
"COST",
"CPKC",
"DCRD",
"DSMT",
"DVPM",
"EDUC",
"FACT",
"FAND",
"FCPM",
"FEES",
"GOVT",
"ICCP",
"IDCP",
"IHRP",
"INSM",
"IVPT",
"MCDM",
"MCFG",
"MSVC",
"NOWS",
"OCDM",
"OCFG",
"OFEE",
"OTHR",
"PADD",
"PTSP",
"RCKE",
"RCPT",
"REBT",
"REFU",
"RENT",
"REOD",
"RIMB",
"RPNT",
"RRBN",
"RVPM",
"SLPI",
"SPLT",
"STDY",
"TBAN",
"TBIL",
"TCSC",
"TELI",
"TMPG",
"TPRI",
"TPRP",
"TRNC",
"TRVC",
"WEBI",
"ANNI",
"CAFI",
"CFDI",
"CMDT",
"DERI",
"DIVD",
"FREX",
"HEDG",
"INVS",
"PRME",
"SAVG",
"SECU",
"SEPI",
"TREA",
"UNIT",
"FNET",
"FUTR",
"ANTS",
"CVCF",
"DMEQ",
"DNTS",
"HLTC",
"HLTI",
"HSPC",
"ICRF",
"LTCF",
"MAFC",
"MARF",
"MDCS",
"VIEW",
"CDEP",
"SWFP",
"SWPP",
"SWRS",
"SWUF",
"ADCS",
"AEMP",
"ALLW",
"ALMY",
"BBSC",
"BECH",
"BENE",
"BONU",
"CCHD",
"COMM",
"CSLP",
"GFRP",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HREC",
"PAYR",
"PEFC",
"PENS",
"PRCP",
"RHBS",
"SALA",
"SSBE",
"LBIN",
"LCOL",
"LFEE",
"LMEQ",
"LMFI",
"LMRK",
"LREB",
"LREV",
"LSFL",
"ESTX",
"FWLV",
"GSTX",
"HSTX",
"INTX",
"NITX",
"PTXP",
"RDTX",
"TAXS",
"VATX",
"WHLD",
"TAXR",
"B112",
"BR12",
"TLRF",
"TLRR",
"AIRB",
"BUSB",
"FERB",
"RLWY",
"TRPT",
"CBTV",
"ELEC",
"ENRG",
"GASB",
"NWCH",
"NWCM",
"OTLC",
"PHON",
"UBIL",
"WTER"
]
}
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
- "Daily"
- "Weekly"
- "EveryTwoWeeks"
- "Monthly"
- "EveryTwoMonths"
- "Quarterly"
- "SemiAnnual"
- "Annual"
{
"title": "frequencyCode",
"example": "Daily",
"type": "string",
"enum": [
"Daily",
"Weekly",
"EveryTwoWeeks",
"Monthly",
"EveryTwoMonths",
"Quarterly",
"SemiAnnual",
"Annual"
]
}
Day of execution as string.
This string consists of up two characters. Leading zeroes are not allowed.
31 is ultimo of the month.
{
"title": "dayOfExecution",
"example": 1,
"type": "integer",
"format": "int32",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31"
]
}
"following" or "preceding" supported as values. This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule.
{
"title": "executionRule",
"example": "following",
"type": "string",
"enum": [
"following",
"preceding"
]
}
PSU Data for Update PSU Authentication.
{
"title": "psuData",
"type": "object",
"properties": {
"password": {
"description": "Password",
"type": "string"
}
},
"required": [
"password"
]
}
Generic Body for a payment initation via JSON.
This generic JSON body can be used to represent valid payment initiations for the following JSON based payment product, which where defined in the Implementation Guidelines:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.
Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.
The following data element are depending on the actual payment product available (in source code):
| Data Element | SCT EU Core | SCT INST EU Core | Target2 Paym. Core | Cross Border CT Core |
|---|---|---|---|---|
| endToEndIdentification | optional | optional | optional | n.a. |
| debtorAccount | mandatory | mandatory | mandatory | mandatory |
| debtorId | n.a. | n.a. | n.a. | n.a. |
| ultimateDebtor | n.a. | n.a. | n.a. | n.a. |
| instructedAmount | mandatory | mandatory | mandatory | mandatory |
| transactionCurrency | n.a. | n.a. | n.a. | n.a. |
| exchangeRateInformation | n.a. | n.a. | n.a. | n.a. |
| creditorAccount | mandatory | mandatory | mandatory | mandatory |
| creditorAgent | optional | optional | optional | conditional |
| creditorAgentName | n.a. | n.a. | n.a. | n.a. |
| creditorName | mandatory | mandatory | mandatory | mandatory |
| creditorId | n.a. | n.a. | n.a. | n.a. |
| creditorAddress | optionaloptional | optional | conditional | |
| creditorNameAndAddress | n.a. | n.a. | n.a. | n.a. |
| ultimateCreditor | n.a. | n.a. | n.a. | n.a. |
| purposeCode | n.a. | n.a. | n.a. | n.a. |
| chargeBearer | n.a. | n.a. | optional | conditional |
| remittanceInformationUnstructured | optional | optional | optional | optional |
| remittanceInformationUnstructuredArray | n.a. | n.a. | n.a. | n.a. |
| remittanceInformationStructured | n.a. | n.a. | n.a. | n.a. |
| requestedExecutionDate | n.a. | n.a. | n.a. | n.a. |
| requestedExecutionTime | n.a. | n.a. | n.a. | n.a. |
IMPORTANT: In this API definition the following holds:
- All data elements mentioned above are defined, but some of them are commented,
i.e. they are only visible in the source code and can be used by uncommenting them. - Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.
- Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.
- Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.
- Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.
- If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.
{
"title": "paymentInitiation_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorAgentName": {
"description": "Creditor Agent Name",
"example": "Creditor Agent Name",
"type": "string",
"maxLength": 70
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Generic body for a bulk payment initation entry.
The bulk entry type is a type which follows the JSON formats for the supported products for single payments excluding the data elements (if supported):
- debtorAccount
- requestedExecutionDate,
- requestedExecutionTime. These data elements may not be contained in any bulk entry.
This data object can be used to represent valid bulk payment initiations entry for the following JSON based payment product, which where defined in the Implementation Guidelines:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.
Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.
The following data element are depending on the actual payment product available (in source code):
| Data Element | SCT EU Core | SCT INST EU Core | Target2 Paym. Core | Cross Border CT Core |
|---|---|---|---|---|
| endToEndIdentification | optional | optional | optional | n.a. |
| debtorId | n.a. | n.a. | n.a. | n.a. |
| ultimateDebtor | n.a. | n.a. | n.a. | n.a. |
| instructedAmount | mandatory | mandatory | mandatory | mandatory |
| transactionCurrency | n.a. | n.a. | n.a. | n.a. |
| exchangeRateInformation | n.a. | n.a. | n.a. | n.a. |
| creditorAccount | mandatory | mandatory | mandatory | mandatory |
| creditorAgent | optional | optional | optional | conditional |
| creditorAgentName | n.a. | n.a. | n.a. | n.a. |
| creditorName | mandatory | mandatory | mandatory | mandatory |
| creditorId | n.a. | n.a. | n.a. | n.a. |
| creditorAddress | optionaloptional | optional | conditional | |
| creditorNameAndAddress | n.a. | n.a. | n.a. | n.a. |
| ultimateCreditor | n.a. | n.a. | n.a. | n.a. |
| purposeCode | n.a. | n.a. | n.a. | n.a. |
| chargeBearer | n.a. | n.a. | optional | conditional |
| remittanceInformationUnstructured | optional | optional | optional | optional |
| remittanceInformationUnstructuredArray | n.a. | n.a. | n.a. | n.a. |
| remittanceInformationStructured | n.a. | n.a. | n.a. | n.a. |
IMPORTANT: In this API definition the following holds:
- All data elements mentioned above are defined, but some of them are commented,
i.e. they are only visible in the source code and can be used by uncommenting them. - Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.
- Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.
- Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.
- Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.
- If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.
{
"title": "paymentInitiationBulkElement_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorAgentName": {
"description": "Creditor Agent Name",
"example": "Creditor Agent Name",
"type": "string",
"maxLength": 70
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Generic Body for a periodic payment initation via JSON.
This generic JSON body can be used to represent valid periodic payment initiations for the following JSON based payment product, which where defined in the Implementation Guidelines:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.
Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.
The following data element are depending on the actual payment product available (in source code):
| Data Element | SCT EU Core | SCT INST EU Core | Target2 Paym. Core | Cross Border CT Core |
|---|---|---|---|---|
| endToEndIdentification | optional | optional | optional | n.a. |
| debtorAccount | mandatory | mandatory | mandatory | mandatory |
| debtorId | n.a. | n.a. | n.a. | n.a. |
| ultimateDebtor | n.a. | n.a. | n.a. | n.a. |
| instructedAmount | mandatory | mandatory | mandatory | mandatory |
| transactionCurrency | n.a. | n.a. | n.a. | n.a. |
| exchangeRateInformation | n.a. | n.a. | n.a. | n.a. |
| creditorAccount | mandatory | mandatory | mandatory | mandatory |
| creditorAgent | optional | optional | optional | conditional |
| creditorAgentName | n.a. | n.a. | n.a. | n.a. |
| creditorName | mandatory | mandatory | mandatory | mandatory |
| creditorId | n.a. | n.a. | n.a. | n.a. |
| creditorAddress | optionaloptional | optional | conditional | |
| creditorNameAndAddress | n.a. | n.a. | n.a. | n.a. |
| ultimateCreditor | n.a. | n.a. | n.a. | n.a. |
| purposeCode | n.a. | n.a. | n.a. | n.a. |
| chargeBearer | n.a. | n.a. | optional | conditional |
| remittanceInformationUnstructured | optional | optional | optional | optional |
| remittanceInformationUnstructuredArray | n.a. | n.a. | n.a. | n.a. |
| remittanceInformationStructured | n.a. | n.a. | n.a. | n.a. |
| requestedExecutionDate | n.a. | n.a. | n.a. | n.a. |
| requestedExecutionTime | n.a. | n.a. | n.a. | n.a. |
| startDate | mandatory | mandatory | mandatory | mandatory |
| executionRule | optional | optional | optional | optional |
| endDate | optional | optional | optional | optional |
| frequency | mandatory | mandatory | mandatory | mandatory |
| dayOfExecution | conditional | conditional | conditional | conditional |
IMPORTANT: In this API definition the following holds:
- All data elements mentioned above are defined, but some of them are commented,
i.e. they are only visible in the source code and can be used by uncommenting them. - Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.
- Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.
- Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.
- Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.
- If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.
{
"title": "periodicPaymentInitiation_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution\nIf not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
Generic Body for a bulk payment initation via JSON.
paymentInformationId is contained in code but commented since it is n.a. and not all ASPSP are able to support this field now. In a later version the field will be mandatory.
{
"title": "bulkPaymentInitiation_json",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "If this element equals 'true', the PSU prefers only one booking entry. \nIf this element equals 'false', the PSU prefers individual booking of all contained individual transactions. \n\nThe ASPSP will follow this preference according to contracts agreed on with the PSU.",
"example": false,
"type": "boolean"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"requestedExecutionTime": {
"type": "string",
"format": "date-time"
},
"payments": {
"description": "A list of generic JSON bodies payment initations for bulk payments via JSON.\n\nNote: Some fields from single payments do not occcur in a bulk payment element",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationBulkElement_json"
}
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON Request body for the "Confirmation of Funds Service"
| cardNumber | String | Optional | Card Number of the card issued by the PIISP. Should be delivered if available. |
| account | Account Reference | Mandatory | PSU's account number. |
| payee | Max70Text | Optional | The merchant where the card is accepted as an information to the PSU. |
| instructedAmount | Amount | Mandatory | Transaction amount to be checked within the funds check mechanism. |
{
"title": "confirmationOfFunds",
"type": "object",
"properties": {
"cardNumber": {
"description": "Card Number of the card issued by the PIISP. \nShould be delivered if available.",
"type": "string",
"maxLength": 35
},
"account": {
"$ref": "#\/definitions\/accountReference"
},
"payee": {
"description": "Name payee",
"type": "string",
"maxLength": 70
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
}
},
"required": [
"account",
"instructedAmount"
]
}
Content of the body of a consent request.
{
"title": "consents",
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent. \nThe content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30. \n\nFuture dates might get adjusted by ASPSP. \n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\". \n\nIn both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.",
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one.",
"example": 4,
"type": "integer",
"minimum": 1,
"format": "int32"
},
"combinedServiceIndicator": {
"description": "If \"true\" indicates that a payment initiation service will be addressed in the same \"session\".",
"example": false,
"type": "boolean"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"combinedServiceIndicator"
]
}
Content of the body of a Update PSU Authentication Request
Password subfield is used.
{
"title": "updatePsuAuthentication",
"type": "object",
"properties": {
"psuData": {
"$ref": "#\/definitions\/psuData"
}
},
"required": [
"psuData"
]
}
Content of the body of a Select PSU Authentication Method Request
{
"title": "selectPsuAuthenticationMethod",
"type": "object",
"properties": {
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID",
"type": "string",
"maxLength": 35
}
},
"required": [
"authenticationMethodId"
]
}
Content of the body of a Transaction Authorisation Request
{
"title": "transactionAuthorisation",
"type": "object",
"properties": {
"scaAuthenticationData": {
"description": "SCA authentication data, depending on the chosen authentication method. \nIf the data is binary, then it is base64 encoded.",
"type": "string"
}
},
"required": [
"scaAuthenticationData"
]
}
The multipart message definition for the initiation of a periodic payment initiation where the information of the payment is contained in an pain.001 message (Part 1) and the additional informations related to the periodic payment is an additional JSON message (Part 2).
{
"title": "periodicPaymentInitiationMultipartBody",
"type": "object",
"properties": {
"xml_sct": {
"type": "object"
},
"json_standingorderType": {
"$ref": "#\/definitions\/periodicPaymentInitiation_xml-Part2-standingorderType_json"
}
}
}
The body part 2 of a periodic payment initation request containes the execution related informations of the periodic payment.
{
"title": "periodicPaymentInitiation_xml-Part2-standingorderType_json",
"type": "object",
"properties": {
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution\nIf not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"startDate",
"frequency"
]
}
Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
{
"title": "paymentInitiationStatusResponse-200_json",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"transactionStatus"
]
}
Body of the response for a successful payment initiation request.
{
"title": "paymentInitationRequestResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.",
"example": "1234-wertiq-983",
"type": "string"
},
"transactionFees": {
"$ref": "#\/definitions\/amount"
},
"transactionFeeIndicator": {
"description": "If equals 'true', the transaction will involve specific transaction cost as shown by the ASPSP in\ntheir public price list or as agreed between ASPSP and PSU.\nIf equals 'false', the transaction will not involve additional specific transaction costs to the PSU.",
"type": "boolean"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksPaymentInitiation"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"paymentId",
"_links"
]
}
Body of the response for a successful payment initiation request.
{
"title": "paymentInitationRequestMultiLevelScaResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.",
"example": "1234-wertiq-983",
"type": "string"
},
"transactionFees": {
"$ref": "#\/definitions\/amount"
},
"transactionFeeIndicator": {
"description": "If equals 'true', the transaction will involve specific transaction cost as shown by the ASPSP in\ntheir public price list or as agreed between ASPSP and PSU.\nIf equals 'false', the transaction will not involve additional specific transaction costs to the PSU.",
"type": "boolean"
},
"_links": {
"$ref": "#\/definitions\/_linksPaymentInitiationMultiLevelSca"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"paymentId",
"_links"
]
}
Body of the response for a successful cancel payment request.
{
"title": "paymentInitiationCancelResponse-202",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksPaymentInitiationCancel"
}
},
"required": [
"transactionStatus"
]
}
Generic JSON response body consistion of the corresponding payment initation JSON body together with an optional transaction status field.
{
"title": "paymentInitiationWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Generic JSON response body consistion of the corresponding periodic payment initation JSON body together with an optional transaction status field.
{
"title": "periodicPaymentInitiationWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution\nIf not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
Generic JSON response body consistion of the corresponding bulk payment initation JSON body together with an optional transaction status field.
{
"title": "bulkPaymentInitiationWithStatusResponse",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "If this element equals 'true', the PSU prefers only one booking entry. \nIf this element equals 'false', the PSU prefers individual booking of all contained individual transactions. \n\nThe ASPSP will follow this preference according to contracts agreed on with the PSU.",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of generic JSON bodies payment initations for bulk payments via JSON.\n\nNote: Some fields from single payments do not occcur in a bulk payment element",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationBulkElement_json"
}
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"payments"
]
}
Body of the JSON response with SCA Status
{
"title": "scaStatusResponse",
"example": {
"description": "Response of an Update PSU Identification for a payment initiation request for the decoupled approach.",
"value": {
"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": {
"scaStatus": {
"href": "\/v1\/payments\/qwer3456tzui7890\/authorisations\/123auth456"
}
}
}
},
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
}
}
}
Body of the JSON response for a Start SCA authorisation request.
{
"title": "startScaprocessResponse",
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksStartScaProcess"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus",
"_links"
]
}
Body of the JSON response for a successful update PSU Identification request.
{
"title": "updatePsuIdenticationResponse",
"type": "object",
"properties": {
"_links": {
"$ref": "#\/definitions\/_linksUpdatePsuIdentification"
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"_links",
"scaStatus"
]
}
Body of the JSON response for a successful update PSU Authentication request.
{
"title": "updatePsuAuthenticationResponse",
"type": "object",
"properties": {
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"_links": {
"$ref": "#\/definitions\/_linksUpdatePsuAuthentication"
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus"
]
}
Body of the JSON response for a successful select PSU Authentication Method request.
{
"title": "selectPsuAuthenticationMethodResponse",
"type": "object",
"properties": {
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksSelectPsuAuthenticationMethod"
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus"
]
}
Body of the JSON response for a successful get signing basket request.
- 'payments': payment initiations which shall be authorised through this signing basket.
- 'consents': consent objects which shall be authorised through this signing basket.
- 'transactionStatus': Only the codes RCVD, ACTC, RJCT are used.
- '_links': The ASPSP might integrate hyperlinks to indicate next (authorisation) steps to be taken.
{
"title": "signingBasketResponse-200",
"type": "object",
"properties": {
"payments": {
"description": "A list of paymentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"consents": {
"description": "A list of consentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus_SBS"
},
"_links": {
"$ref": "#\/definitions\/_linksSigningBasket"
}
},
"required": [
"transactionStatus"
]
}
{
"title": "signingBasketStatusResponse-200",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus_SBS"
}
},
"required": [
"transactionStatus"
]
}
Body of the JSON response for a successful create signing basket request.
{
"title": "signingBasketResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus_SBS"
},
"basketId": {
"description": "Resource identification of the generated signing basket resource.",
"example": "1234-basket-567",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksSigningBasket"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"basketId",
"_links"
]
}
Body of the JSON response for a successful conset request.
{
"title": "consentsResponse-201",
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
},
"consentId": {
"description": "ID of the corresponding consent object as returned by an Account Information Consent Request.",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different\nauthentication methods.\n\nDepending on the risk management of the ASPSP this choice might be offered before or after the PSU\nhas been identified with the first relevant factor, or if an access token is transported.\n\nIf this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection'\ncontained in the response body.\n\nThese methods shall be presented towards the PSU for selection by the TPP.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"$ref": "#\/definitions\/_linksConsents"
},
"message": {
"description": "Text to be displayed to the PSU, e.g. in a Decoupled SCA Approach.",
"type": "string",
"maxLength": 512
}
},
"required": [
"consentStatus",
"consentId",
"_links"
]
}
Body of the JSON response for a successful get status request for a consent.
{
"title": "consentStatusResponse-200",
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"consentStatus"
]
}
Body of the JSON response for a successfull get consent request.
{
"title": "consentInformationResponse-200_json",
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "\"true\", if the consent is for recurring access to the account data.\n\n\"false\", if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent. \nThe content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30. \n\nFuture dates might get adjusted by ASPSP. \n\nIf a maximal available date is requested, a date in far future is to be used: \"9999-12-31\". \n\nIn both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.",
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.\nFor a one-off access, this attribute is set to \"1\".\n\nThe frequency needs to be greater equal to one.",
"example": 4,
"type": "integer",
"minimum": 1,
"format": "int32"
},
"lastActionDate": {
"description": "This date is containing the date of the last action on the consent object either through \nthe XS2A interface or the PSU\/ASPSP interface having an impact on the status.",
"example": "2018-07-01",
"type": "string",
"format": "date"
},
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"lastActionDate",
"consentStatus"
]
}
Body of the response for a successful read balance for an account request.
{
"title": "readAccountBalanceResponse-200",
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the response for a successful read balance for a card account request.
{
"title": "readCardAccountBalanceResponse-200",
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the JSON response for a successful read transaction list request. This account report contains transactions resulting from the query parameters.
{
"title": "transactionsResponse-200_json",
"example": {
"description": "Response in JSON format for an access on a regular account",
"value": {
"account": {
"iban": "DE2310010010123456788"
},
"transactions": {
"booked": [
{
"transactionId": "1234567",
"creditorName": "John Miles",
"creditorAccount": {
"iban": "DE67100100101306118605"
},
"transactionAmount": {
"currency": "EUR",
"amount": "256.67"
},
"bookingDate": "2017-10-25",
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 1"
},
{
"transactionId": "1234568",
"debtorName": "Paul Simpson",
"debtorAccount": {
"iban": "NL76RABO0359400371"
},
"transactionAmount": {
"currency": "EUR",
"amount": "343.01"
},
"bookingDate": "2017-10-25",
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 2"
}
],
"pending": [
{
"transactionId": "1234569",
"creditorName": "Claude Renault",
"creditorAccount": {
"iban": "FR7612345987650123456789014"
},
"transactionAmount": {
"currency": "EUR",
"amount": "-100.03"
},
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 3"
}
],
"_links": {
"account": {
"href": "\/v1\/accounts\/3dc3d5b3-7023-4848-9853-f5400a64e80f"
}
}
}
}
},
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"transactions": {
"$ref": "#\/definitions\/accountReport"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksDownload"
}
}
}
Body of the JSON response for a successful read card account transaction list request. This card account report contains transactions resulting from the query parameters.
{
"title": "cardAccountsTransactionsResponse200",
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"cardTransactions": {
"$ref": "#\/definitions\/cardAccountReport"
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.\nThe list migght be restricted to the current ballance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"$ref": "#\/definitions\/_linksDownload"
}
}
}
A _link object with all availabel link types
{
"title": "_linksAll",
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"updateProprietaryData": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"updateEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
},
"account": {
"$ref": "#\/definitions\/hrefType"
},
"balances": {
"$ref": "#\/definitions\/hrefType"
},
"transactions": {
"$ref": "#\/definitions\/hrefType"
},
"transactionDetails": {
"$ref": "#\/definitions\/hrefType"
},
"cardAccount": {
"$ref": "#\/definitions\/hrefType"
},
"cardTransactions": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
},
"download": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- 'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication':
The link to the authorisation end-point, where the authorisation sub-resource has to be generated while
uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element "scaMethods"
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
{
"title": "_linksPaymentInitiation",
"example": {
"scaRedirect": {
"href": "https:\/\/www.testbank.com\/asdfasdfasdf"
},
"self": {
"href": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983"
}
},
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where an authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
{
"title": "_linksPaymentInitiationMultiLevelSca",
"type": "object",
"properties": {
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'startAuthorisation': In case, where just the authorisation process of the cancellation needs to be started, but no additional data needs to be updated for time being (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': In case where a PSU Identification needs to be updated when starting the cancellation authorisation: The link to the cancellation-authorisations end-point, where the cancellation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': In case of a yet to be created authorisation sub-resource: The link to the cancalation authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the cancellation-authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
{
"title": "_linksPaymentInitiationCancel",
"type": "object",
"properties": {
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
{
"title": "_linksUpdatePsuIdentification",
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU. Type of links admitted in this response:
- 'selectAuthenticationMethod': 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. This link is only contained, if the PSU is already identified or authenticated with the first relevant factor or alternatively an access token, if SCA is required and if the PSU has a choice between different authentication methods. If this link is contained, then there is also the data element 'scaMethods' contained in the response body.
- 'authoriseTransaction': The link to the resource, where the "Transaction Authorisation Request" is sent to. This is the link to the resource which will authorise the transaction by checking the SCA authentication data within the Embedded SCA approach.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
{
"title": "_linksUpdatePsuAuthentication",
"type": "object",
"properties": {
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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.
Remark: This method can be applied before or after PSU identification. This leads to many possible hyperlink responses. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- "scaRedirect": In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- "scaOAuth": In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- "updatePsuIdentification": The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.
- "updatePsuAuthentication": The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded. "authoriseTransaction": The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS. "scaStatus": The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
{
"title": "_linksSelectPsuAuthenticationMethod",
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- 'updatePsuIdentification': The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.
- 'startAuthorisationWithPsuAuthentication':
The link to the authorisation or cancellation authorisation sub-resource,
where PSU authentication data needs to be uploaded.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'selectAuthenticationMethod': The link to the authorisation or cancellation authorisation sub-resource, where the selected authentication method needs to be uploaded. This link is contained under exactly the same conditions as the data element 'scaMethods'.
- 'authoriseTransaction': The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
{
"title": "_linksStartScaProcess",
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"updatePsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/hrefType"
},
"authoriseTransaction": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A list of hyperlinks to be recognised by the TPP.
Type of links admitted in this response:
- "download": a link to a resource, where the transaction report might be downloaded from in case where transaction reports have a huge size.
Remark: This feature shall only be used where camt-data is requested which has a huge size.
{
"title": "_linksDownload",
"type": "object",
"properties": {
"download": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"download"
]
}
A list of hyperlinks to be recognised by the TPP.
Type of links admitted in this response (which might be extended by single ASPSPs as indicated in its XS2A documentation):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of an OAuth2 based Redirect Approach, the ASPSP is transmitting the link where the configuration of the OAuth2 Server is defined. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- 'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication':
The link to the authorisation end-point, where the authorisation sub-resource has to be generated
while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the Establish Account Information Consent resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the status of the account information consent.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
{
"title": "_linksConsents",
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
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. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- 'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the encrypted PSU authentication data.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
{
"title": "_linksSigningBasket",
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType"
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithTransactionAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
{
"title": "_linksAccountReport",
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"account"
]
}
{
"title": "_linksCardAccountReport",
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/hrefType"
},
"first": {
"$ref": "#\/definitions\/hrefType"
},
"next": {
"$ref": "#\/definitions\/hrefType"
},
"previous": {
"$ref": "#\/definitions\/hrefType"
},
"last": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"cardAccount"
]
}
{
"title": "_linksTransactionDetails",
"type": "object",
"properties": {
"transactionDetails": {
"$ref": "#\/definitions\/hrefType"
}
},
"required": [
"transactionDetails"
]
}
Links to the account, which can be directly used for retrieving account information from this dedicated account.
Links to "balances" and/or "transactions"
These links are only supported, when the corresponding consent has been already granted.
{
"title": "_linksAccountDetails",
"type": "object",
"properties": {
"balances": {
"$ref": "#\/definitions\/hrefType"
},
"transactions": {
"$ref": "#\/definitions\/hrefType"
}
}
}
Category of the TPP message category
{
"title": "tppMessageCategory",
"example": "ERROR",
"type": "string",
"enum": [
"ERROR",
"WARNING"
]
}
Message codes for HTTP Error codes 2XX.
{
"title": "MessageCode2XX",
"example": "WARNING",
"type": "string",
"enum": [
"WARNING"
]
}
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_AIS",
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"SESSIONS_NOT_SUPPORTED"
]
}
Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_PIS",
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"PAYMENT_FAILED",
"EXECUTION_DATE_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_PIIS",
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"CARD_INVALID",
"NO_PIIS_ACTIVATION"
]
}
Message codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_SBS",
"example": "FORMAT_ERROR",
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"CONSENT_UNKNOWN",
"REFERENCE_MIX_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_PIS",
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED",
"REQUIRED_KID_MISSING"
]
}
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_AIS",
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
]
}
Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_PIIS",
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
]
}
Message codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_SBS",
"example": "CERTIFICATE_INVALID",
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKE",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"CORPORATE_ID_INVALID",
"PSU_CREDENTIALS_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
]
}
Message codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_PIS",
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"PRODUCT_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_AIS",
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
]
}
Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_PIIS",
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
]
}
Message codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_SBS",
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
]
}
Message codes defined for PIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_PIS",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN",
"PRODUCT_UNKNOWN"
]
}
Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_AIS",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
]
}
Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_PIIS",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
]
}
Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_SBS",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
]
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIS_CANC",
"example": "CANCELLATION_INVALID",
"type": "string",
"enum": [
"CANCELLATION_INVALID",
"SERVICE_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_AIS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIIS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_SBS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
{
"title": "MessageCode406_AIS",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"enum": [
"REQUESTED_FORMATS_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_AIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_PIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_PIIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for signing baskets for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_SBS",
"example": "REFERENCE_STATUS_INVALID",
"type": "string",
"enum": [
"REFERENCE_STATUS_INVALID",
"STATUS_INVALID"
]
}
Message codes for HTTP Error code 429 (TOO MANY REQUESTS).
{
"title": "MessageCode429_AIS",
"example": "ACCESS_EXCEEDED",
"type": "string",
"enum": [
"ACCESS_EXCEEDED"
]
}
{
"title": "tppMessage2XX",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error codes 2XX.",
"example": "WARNING",
"type": "string",
"default": "WARNING"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SBS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SBS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SBS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIS_CANC",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage406_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_SBS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SBS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage429_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIS.
{
"title": "Error400_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for AIS.
{
"title": "Error400_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError1"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIIS.
{
"title": "Error400_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError2"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for signing baskets.
{
"title": "Error400_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SBS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError3"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIS.
{
"title": "Error401_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError4"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for AIS.
{
"title": "Error401_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError5"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIIS.
{
"title": "Error401_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError6"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for signing baskets.
{
"title": "Error401_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SBS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError7"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIS.
{
"title": "Error403_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError8"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for AIS.
{
"title": "Error403_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError9"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIIS.
{
"title": "Error403_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError10"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for signing baskets.
{
"title": "Error403_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SBS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError11"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIS.
{
"title": "Error404_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError12"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for AIS.
{
"title": "Error404_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError13"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIIS.
{
"title": "Error404_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError14"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for signing baskets.
{
"title": "Error404_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError15"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIS.
{
"title": "Error405_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError16"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for a pament cancelation (PIS).
{
"title": "Error405_PIS_CANC",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError17"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for AIS.
{
"title": "Error405_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError18"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIIS.
{
"title": "Error405_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError19"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for signing baskets.
{
"title": "Error405_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError20"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 406 for AIS.
{
"title": "Error406_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError21"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIS.
{
"title": "Error409_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError22"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for AIS.
{
"title": "Error409_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError23"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIIS.
{
"title": "Error409_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError24"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for signing baskets.
{
"title": "Error409_SBS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SBS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError25"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 429 for AIS.
{
"title": "Error429_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError26"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
},
"required": [
"type",
"code"
]
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIS_CANC",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIS_CANC"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.
{
"title": "Error406_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage406_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_PIIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_SBS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_SBS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.
{
"title": "Error429_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage429_AIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError1",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError2",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError3",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SBS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError4",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError5",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError6",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError7",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SBS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError8",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError9",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError10",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError11",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SBS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError12",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError13",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError14",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError15",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError16",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError17",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError18",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError19",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError20",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError21",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError22",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError23",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError24",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError25",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SBS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807] in case of a HTTP error code 429 for.
{
"title": "AdditionalError26",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. \nCould be in local language. \nTo be provided by ASPSPs.",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. \nXPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
}
},
"required": [
"code"
]
}
Optional if supported by API provider.
Only the value "allAccounts" is admitted.
{
"title": "AllPsd2",
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts"
]
}
Optional if supported by API provider.
Only the values "allAccounts" or "allAccountsWithBalances" is admitted.
{
"title": "AvailableAccounts",
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts",
"allAccountsWithBalances"
]
}
{
"title": "bookingStatus",
"example": "booked",
"type": "string",
"enum": [
"booked",
"pending",
"both"
]
}
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
{
"title": "OtpFormat",
"example": "characters",
"type": "string",
"enum": [
"characters",
"integer"
]
}
{
"title": "payment-product",
"example": "sepa-credit-transfers",
"type": "string",
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}
{
"title": "payment-service",
"example": "payments",
"type": "string",
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
{
"title": "PSU-Http-Method",
"example": "GET",
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}
{
"title": "RateType",
"example": "SPOT",
"type": "string",
"enum": [
"SPOT",
"SALE",
"AGRD"
]
}
{
"title": "TPP-Explicit-Authorisation-Preferred",
"example": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
{
"title": "TPP-Redirect-Preferred",
"example": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
{
"title": "TPP-Rejection-NoFunds-Preferred",
"example": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
Specifies the usage of the account
- PRIV: private personal account
- ORGA: professional account
{
"title": "Usage",
"example": "PRIV",
"type": "string",
"enum": [
"PRIV",
"ORGA"
]
}
Equals "true" if sufficient funds are available at the time of the request, "false" otherwise.
{
"title": "V1FundsConfirmationsResponse",
"type": "object",
"properties": {
"fundsAvailable": {
"type": "boolean"
}
},
"required": [
"fundsAvailable"
]
}