This set of methods involves the implementation of a PSD2 compliant API based on Berlin Group XS2A Framework.
Base Gateway API Endpoint
Paths
/{payment-service}/{payment-product}
initiatePayment
Initiates a payment at the ASPSP, sending information via either a JSON body or an pain.001 body, depending on the payment product and the payment service in the path.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
The addressed payment product endpoint: sepa-credit-transfers instant-sepa-credit-transfers *cross-border-credit-transfers
{
"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}"
}
The body part 2 of a periodic payment initiation request containes the execution related informations of the periodic payment.
The request body for single payments
application/x-www-form-urlencoded
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Service Unavailable
Internal Server Error
/{payment-service}/{payment-product}/{paymentId}
getPaymentInformation
Returns the content of a payment object
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
The addressed payment product endpoint: sepa-credit-transfers instant-sepa-credit-transfers *cross-border-credit-transfers
{
"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
Service Unavailable
Internal Server Error
cancelPayment
This method initiates the cancellation of a payment.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
The addressed payment product endpoint: sepa-credit-transfers instant-sepa-credit-transfers *cross-border-credit-transfers
{
"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}"
}
Accepted
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Service Unavailable
Internal Server Error
/{payment-service}/{payment-product}/{paymentId}/status
getPaymentInitiationStatus
Check the transaction status of a payment initiation.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
The addressed payment product endpoint: sepa-credit-transfers instant-sepa-credit-transfers *cross-border-credit-transfers
{
"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
Service Unavailable
Internal Server Error
/{payment-service}/{payment-product}/{paymentId}/authorisations
startPaymentAuthorisation
Create an authorisation sub-resource and start the authorisation process.The message might in addition transmit authentication and authorisation related data.This method is iterated n times for a n times SCA authorisation in acorporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the transaction.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
Payment service:
Possible values are:
- payments
- bulk-payments
- periodic-payments
{
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
The addressed payment product endpoint: sepa-credit-transfers instant-sepa-credit-transfers *cross-border-credit-transfers
{
"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.
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.
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.
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}"
}
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Service Unavailable
Internal Server Error
getPaymentInitiationAuthorisation
Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Resource Owner Implicit Grant Type
This header should be in the form "Bearer Token", where Token is returned from the call to OAuth2.
Application's client id
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
/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
getPaymentInitiationScaStatus
This method returns the SCA status of a payment initiation's authorisation sub-resource.
Resource Owner Implicit Grant Type
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.
Resource identification of the related SCA.
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
Service Unavailable
Internal Server Error
updatePaymentPsuData
This methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed.
Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.
There are several possible Update PSU Data requests in the context of payment initiation services needed, which depends on the SCA approach:
- Redirect SCA Approach:
A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
- Decoupled SCA Approach:
A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
- Embedded SCA Approach:
The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.
The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:
- Select an SCA method in case of several SCA methods are available for the customer.
There are the following request types on this access path:
- Update PSU Identification
- Update PSU Authentication
- Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
- Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Resource Owner Implicit Grant Type
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.
Resource identification of the related SCA.
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.
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.
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}"
}
The request body has one of the following schemas, depending on the data to be updated: 1) selectPsuAuthenticationMethod, 2) transactionAuthorisation. The respective success responses (200 OK) are 1)SelectPsuAuthenticationMethodResponse and 2)scaStatusResponse.
{
"schema": {
"type": "object"
}
}
OK
{
"schema": {
"type": "object"
},
"examples": {
"application\/json": {
"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": "\/payments\/qwer3456tzui7890\/authorisations\/123auth456"
}
}
}
}
},
"headers": {
"X-Request-ID": {
"type": "string",
"default": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
},
"ASPSP-SCA-Approach": {
"type": "string",
"default": "EMBEDDED"
}
}
}
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
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. This can be used by the first agent to report to the debtor that the transaction has been completed and 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 semantic 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. This code is 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. 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 semantic validations are successful. 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. 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.
{
"example": "ACCC",
"type": "string",
"enum": [
"ACCC",
"ACCP",
"ACSC",
"ACSP",
"ACTC",
"ACWC",
"ACWP",
"RCVD",
"PDNG",
"RJCT",
"CANC",
"ACFC",
"PATC",
"PART"
]
}
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.
{
"example": "received",
"type": "string",
"enum": [
"received",
"psuIdentified",
"psuAuthenticated",
"scaMethodSelected",
"started",
"finalised",
"failed",
"exempted"
]
}
Authentication Object
{
"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. Valid values:
- '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 at predefined intervals, by a chip device.
- 'PUSH_OTP': An OTP is pushed to the PSU's registered winbank mobile APP and displayed to the PSU.
- 'TOUCH_OTP': A request for approval is sent to PSU's registered winbank mobile app. If PSU approves the transaction, using phones touch functionality or dedicated pin, the SCA gets completed automatically.
{
"example": "SMS_OTP",
"type": "string",
"enum": [
"SMS_OTP",
"CHIP_OTP",
"PUSH_OTP",
"TOUCH_OTP"
]
}
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.
{
"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
{
"type": "object",
"properties": {
"href": {
"description": "Link to a resource",
"example": "\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
An array of all authorisationIds
{
"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).
{
"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}"
}
}
}
Object containing information about a specific 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"
]
}
Object describing an amount as a combination of its value and currency code
{
"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"
]
}
Generic Body for a payment initiation via JSON. This generic JSON body can be used to represent valid payment initiations for the following JSON based payment product:
- sepa-credit-transfers
- instant-sepa-credit-transfers
- target-2-payments
- cross-border-credit-transfers
{
"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"
]
}
Content of the body of a Transaction Authorisation Request
{
"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"
]
}
Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
{
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"transactionStatus"
]
}
Body of the response for a successful payment initiation request.
{
"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 cancel payment request.
{
"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 consisting of the corresponding payment initiation JSON body together with an optional transaction status field.
{
"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"
]
}
Body of the JSON response with SCA Status
{
"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": "\/payments\/qwer3456tzui7890\/authorisations\/123auth456"
}
}
}
},
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
}
}
}
Body of the JSON response for a Start SCA authorisation request.
{
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"authorisationId": {
"description": "Resource identification of the related SCA",
"example": "123auth456",
"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\/_linksStartScaProcess"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus",
"authorisationId",
"_links"
]
}
Body of the JSON response for a successful select PSU Authentication Method request.
{
"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"
]
}
A _link object with all available link types
{
"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 _link object with available link types for payment initiation
{
"example": {
"scaRedirect": {
"href": "https:\/\/www.testbank.com\/asdfasdfasdf"
},
"self": {
"href": "\/payments\/sepa-credit-transfers\/1234-wertiq-983"
}
},
"type": "object",
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/hrefType",
"description": "In case of an SCA Redirect Approach, the bank is transmitting the link to which to redirect the PSU browser."
},
"scaOAuth": {
"$ref": "#\/definitions\/hrefType",
"description": "In case of a SCA OAuth2 Approach, the bank 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": {
"$ref": "#\/definitions\/hrefType",
"description": "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": {
"$ref": "#\/definitions\/hrefType",
"description": "The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data."
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType",
"description": "The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data."
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType",
"description": "Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType",
"description": "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": {
"$ref": "#\/definitions\/hrefType",
"description": "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": {
"$ref": "#\/definitions\/hrefType",
"description": "The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data."
},
"status": {
"$ref": "#\/definitions\/hrefType",
"description": "The link to retrieve the transaction status of the payment initiation."
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType",
"description": "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."
},
"execute": {
"$ref": "#\/definitions\/hrefType",
"description": "The link to the second step payment execution"
}
}
}
A _link object with available link types for payment initiation cancellation
{
"type": "object",
"properties": {
"startAuthorisation": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuIdentification": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"$ref": "#\/definitions\/hrefType"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/hrefType"
},
"execute": {
"description": "The link to the second step payment execution",
"$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.
{
"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"
},
"execute": {
"$ref": "#\/definitions\/hrefType"
}
}
}
A _link object with available link types for starting the SCA process
{
"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"
},
"execute": {
"description": "The link to the second step payment execution",
"$ref": "#\/definitions\/hrefType"
}
}
}
Category of the TPP message
{
"example": "ERROR",
"type": "string",
"enum": [
"ERROR",
"WARNING"
]
}
Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
{
"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 PIS for HTTP Error code 401 (UNAUTHORIZED).
{
"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 defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
{
"example": "CONSENT_UNKNOWN",
"type": "string",
"enum": [
"CONSENT_UNKNOWN",
"SERVICE_BLOCKED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"PRODUCT_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 404 (NOT FOUND).
{
"example": "RESOURCE_UNKNOWN",
"type": "string",
"enum": [
"RESOURCE_UNKNOWN",
"PRODUCT_UNKNOWN"
]
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"example": "CANCELLATION_INVALID",
"type": "string",
"enum": [
"CANCELLATION_INVALID",
"SERVICE_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 406 (NOT ACCEPTABLE).
{
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"enum": [
"REQUESTED_FORMATS_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 408 (REQUEST TIMEOUT).
{
"example": "REQUEST_TIMEOUT",
"type": "string",
"enum": [
"REQUEST_TIMEOUT"
]
}
Message codes defined for PIS for HTTP Error code 409 (CONFLICT).
{
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 415 (UNSUPPORTED MEDIA TYPE).
{
"example": "UNSUPPORTED_MEDIA_TYPE",
"type": "string",
"enum": [
"UNSUPPORTED_MEDIA_TYPE"
]
}
Message codes for HTTP Error code 503 (SERVICE UNAVAILABLE).
{
"example": "SERVICE_UNAVAILABLE",
"type": "string",
"enum": [
"SERVICE_UNAVAILABLE"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"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"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode406_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode408_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"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"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode415_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode503_PIS"
},
"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.
{
"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 401 for 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 403 for 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 404 for 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 405 for 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).
{
"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 406 for 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\/MessageCode406_PIS"
},
"_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.
{
"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"
]
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"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 401.
{
"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 403.
{
"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 404.
{
"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 401.
{
"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.
{
"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 406.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage406_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 408.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage408_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"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 415.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage415_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 503.
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage503_PIS"
}
},
"_links": {
"$ref": "#\/definitions\/_linksAll"
}
}
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"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].
{
"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].
{
"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].
{
"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].
{
"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 cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"default": "SERVICE_INVALID",
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"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"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"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",
"default": "STATUS_INVALID",
"$ref": "#\/definitions\/MessageCode409_PIS"
}
},
"required": [
"code"
]
}
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
{
"example": "characters",
"type": "string",
"enum": [
"characters",
"integer"
]
}
{
"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"
]
}
{
"example": "payments",
"type": "string",
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
Content of the body of a Select PSU Authentication Method Request
{
"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"
]
}