--- swagger: "2.0" info: x-ibm-name: psd2-signing-baskets-api-132 title: Signing Baskets API version: 1.3.2 description: "" schemes: - https basePath: /psd2-signing-baskets-api-1.3.2/v1 consumes: - application/json produces: - application/json securityDefinitions: clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /signing-baskets: post: description: Create a signing basket resource for authorising several transactions with one SCA method. summary: Create a signing basket resource tags: - Signing Basket Service (SBS) operationId: createSigningBasket produces: - application/json parameters: - name: body in: body required: false description: "" schema: $ref: '#/definitions/signingBasket' - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: The certificate used for signing the request, in base64 encoding. - name: PSU-ID in: header required: false type: string description: Client ID of the PSU in the ASPSP client interface. - name: PSU-ID-Type in: header required: false type: string description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. - name: PSU-Corporate-ID in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: PSU-Corporate-ID-Type in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: Consent-ID in: header required: false type: string description: This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. - name: PSU-IP-Address in: header required: true type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: TPP-Redirect-Preferred in: header required: false type: string description: 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. - name: TPP-Redirect-URI in: header required: false type: string description: URI of the TPP, where the transaction flow shall be redirected to after a Redirect. - name: TPP-Nok-Redirect-URI in: header required: false type: string description: 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. - name: TPP-Explicit-Authorisation-Preferred in: header required: false type: string description: If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. responses: 201: description: Created schema: $ref: '#/definitions/signingBasketResponse-201' headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid ASPSP-SCA-Approach: description: | This data element must be contained, if the SCA Approach is already fixed. Possible values are * EMBEDDED * DECOUPLED * REDIRECT The OAuth SCA approach will be subsumed by REDIRECT. type: string enum: - EMBEDDED - DECOUPLED - REDIRECT 400: description: Bad Request headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error400_NG_SBS' 401: description: Unauthorized headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error401_NG_SBS' 403: description: Forbidden headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error403_NG_SBS' 404: description: Not found headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error404_NG_SBS' 405: description: Method Not Allowed headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error405_NG_SBS' 406: description: Not Acceptable headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid 408: description: Request Timeout headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid 409: description: Conflict headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid schema: $ref: '#/definitions/Error409_NG_SBS' 415: description: Unsupported Media Type headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid 429: description: Too Many Requests headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid 500: description: Internal Server Error headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid 503: description: Service Unavailable headers: Location: description: Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid /signing-baskets/{basketId}: get: description: Returns the content of a payment object. summary: Get Payment Information tags: - Signing Basket Service (SBS) operationId: getBasketformation produces: - application/json parameters: - name: basketId type: string required: true in: path description: Resource identification of the generated basket initiation resource. - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained." - name: PSU-IP-Address in: header required: false type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. responses: 200: description: "" schema: $ref: '#/definitions/BasketPaymentInitResponseList' 400: description: Bad Request headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error400_NG_PIS' 401: description: Unauthorized headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 408: description: Request Timeout headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 409: description: Conflict headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsuported Media Type headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 429: description: Too Many Requests headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 500: description: Internal Server Error headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 503: description: Service Unavailable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 delete: description: "Delete the signing basket structure as long as no (partial) authorisation has yet been applied. \nThe undlerying transactions are not affected by this deletion.\n\nRemark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. \nNevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.\n" summary: deleteSigningBasket tags: - Signing Basket Service (SBS) operationId: cancelSigningBasket deprecated: false produces: - application/json parameters: - name: basketId in: path required: true type: string description: This identification of the corresponding signing basket object. responses: 204: description: No Content headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 400: description: Bad Request headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error400_NG_SBS' 401: description: Unauthorized headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error401_NG_SBS' 403: description: Forbidden headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error403_NG_SBS' 404: description: Not found headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error404_NG_SBS' 405: description: Method Not Allowed headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error405_NG_SBS' 406: description: Not Acceptable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 408: description: Request Timeout headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 409: description: Conflict headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error409_NG_SBS' 415: description: Unsuported Media Type headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 429: description: Too Many Requests headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 500: description: Internal Server Error headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 503: description: Service Unavailable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 /signing-baskets/{basketId}/status: get: description: Returns the status of a signing basket object. summary: Read the status of the signing basket tags: - Signing Basket Service (SBS) operationId: getSigningBasketStatus produces: - application/json parameters: - name: basketId type: string required: true in: path description: Resource identification of the generated basket initiation resource. - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained." - name: PSU-ID in: header required: false type: string description: |- 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. - name: PSU-ID-Type in: header required: false type: string description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. - name: PSU-Corporate-ID in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: PSU-Corporate-ID-Type in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: PSU-IP-Address in: header required: false type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. responses: 200: description: "" schema: $ref: '#/definitions/OK_200_SigningBasketStatus' headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 400: description: Bad Request headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error400_NG_PIS' 401: description: Unauthorized headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 408: description: Request Timeout headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 409: description: Conflict headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsuported Media Type headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 429: description: Too Many Requests headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 500: description: Internal Server Error headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 503: description: Service Unavailable headers: Location: type: string X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 /signing-baskets/{basketId}/authorisations: post: description: | Create an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and authorisation related data. This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the signing-baskets. The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST signing basket call. The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource. This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. * 'startAuthorisationWithPsuIdentfication', * 'startAuthorisationWithPsuAuthentication' * 'startAuthorisationWithEncryptedPsuAuthentication' * 'startAuthorisationWithAuthentciationMethodSelection' * The related payment initiation cannot yet be executed since a multilevel SCA is mandated. * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above. * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation. * The signing basket needs to be authorised yet. summary: startSigningBasketAuthorisation tags: - Signing Baskets (SBS) operationId: postSigningBasketAuthorisation deprecated: false produces: - application/json parameters: - name: basketId in: path required: true type: string description: This identification of the corresponding signing basket object. - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: |- The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. - name: PSU-ID in: header required: false type: string description: |- 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. - name: PSU-ID-Type in: header required: false type: string description: Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. - name: PSU-Corporate-ID in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: PSU-Corporate-ID-Type in: header required: false type: string description: Might be mandated in the ASPSP's documentation. Only used in a corporate context. - name: TPP-Redirect-Preferred in: header required: false enum: - true - false type: string description: |- 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. - name: TPP-Redirect-URI in: header required: false type: string description: |- 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. - name: TPP-Nok-Redirect-URI in: header required: false type: string description: |- 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. - name: PSU-IP-Address in: header required: false type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. - name: body in: body required: false description: "" schema: type: object responses: 201: description: Created schema: $ref: '#/definitions/startScaprocessResponse' headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ASPSP-SCA-Approach: type: string default: EMBEDDED 400: description: Bad Request schema: $ref: '#/definitions/Error400_NG_SBS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_SBS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_SBS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_SBS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_SBS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_SBS' 415: description: Unsupported Media Type 429: description: Too Many Requests 500: description: Internal Server Error 503: description: Service Unavailable get: description: | 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. summary: getSigningBasketAuthorisation tags: - Signing Baskets (SBS) operationId: getSigningBasketAuthorisation deprecated: false produces: - application/json parameters: - name: basketId in: path required: true type: string description: This identification of the corresponding signing basket object. - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: |- The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. - name: PSU-IP-Address in: header required: false type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. responses: 200: description: OK schema: $ref: '#/definitions/authorisations' headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 400: description: Bad Request schema: $ref: '#/definitions/Error400_NG_SBS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_SBS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_SBS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_SBS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_SBS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_SBS' 415: description: Unsupported Media Type 429: description: Too Many Requests 500: description: Internal Server Error 503: description: Service Unavailable /signing-baskets/{basketId}/authorisations/{authorisationId}: get: description: | This method returns the SCA status of a signing basket's authorisation sub-resource. summary: getSigningBasketScaStatus tags: - Signing Baskets (SBS) operationId: getSigningBasketScaStatus deprecated: false produces: - application/json parameters: - name: basketId in: path required: true type: string description: This identification of the corresponding signing basket object. - name: authorisationId in: path required: true type: string description: Resource identification of the related SCA. - name: X-Request-ID in: header required: true type: string format: uuid description: ID of the request, unique to the call, as determined by the initiating party. - name: Digest in: header required: false type: string description: Is contained if and only if the "Signature" element is contained in the header of the request. - name: Signature in: header required: false type: string description: A signature of the request by the TPP on application level. This might be mandated by ASPSP. - name: TPP-Signature-Certificate in: header required: false type: string description: |- The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. - name: PSU-IP-Address in: header required: false type: string description: The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. - name: PSU-IP-Port in: header required: false type: string description: The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. - name: PSU-Accept in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Charset in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Encoding in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-Accept-Language in: header required: false type: string description: The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. - name: PSU-User-Agent in: header description: |- The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Examples * Android: "Myappa/1.2 Dalvik/2.1.0 (Linux; U; Android 6.0.1; vivo 1610 Build/MMB29M)" * iOS: "MyApp/1 iPhone5,2 iOS/10_1 CFNetwork/808.3 Darwin/16.3.0" type: string - name: PSU-Http-Method in: header required: false enum: - GET - POST - PUT - PATCH - DELETE type: string description: |- HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE - name: PSU-Device-ID in: header required: false type: string format: uuid description: |- 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. - name: PSU-Geo-Location in: header required: false type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} description: The forwarded Geo Location of the corresponding http request between PSU and TPP if available. responses: 200: description: OK schema: $ref: '#/definitions/scaStatusResponse' headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 400: description: Bad Request schema: $ref: '#/definitions/Error400_NG_SBS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_SBS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_SBS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_SBS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_SBS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_SBS' 415: description: Unsupported Media Type 429: description: Too Many Requests 500: description: Internal Server Error 503: description: Service Unavailable definitions: psuMessageText: description: Text to be displayed to the PSU type: string maxLength: 512 _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' new-property-1: $ref: '#/definitions/hrefType' description: "A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the\n\t response depend on the dynamical decisions of the ASPSP when processing the request.\n\t * 'scaRedirect':\n\t\t In case of an SCA Redirect Approach, the ASPSP is transmitting the link to\n\t\t which to redirect the PSU browser.\n\t * 'scaOAuth':\n\t\t In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of\n\t\t the Authorisation Server can be retrieved. The configuration follows the\n\t\t OAuth 2.0 Authorisation Server Metadata specification.\n\t * 'startAuthorisation':\n\t\t In case, where an explicit start of the transaction authorisation is needed,\n\t\t but no more data needs to be updated (no authentication method to be selected,\n\t\t \ no PSU identification nor PSU authentication data to be uploaded).\n\t * 'startAuthorisationWithPsuIdentification':\n\t\t The link to the authorisation end-point, where the authorisation sub-resource\n\t\t has to be generated while uploading the PSU identification data.\n\t * 'startAuthorisationWithPsuAuthentication':\n\t\t \ The link to the authorisation end-point, where the authorisation sub-resource\n\t\t \ has to be generated while uploading the PSU authentication data.\n\t * 'startAuthorisationWithEncryptedPsuAuthentication':\n\t\t The link to the authorisation end-point, where the authorisation sub-resource has\n\t\t to be generated while uploading the encrypted PSU authentication data.\n\t * 'startAuthorisationWithAuthenticationMethodSelection':\n\t\t \ The link to the authorisation end-point, where the authorisation sub-resource\n\t\t \ has to be generated while selecting the authentication method.\n\t\t This link is contained under exactly the same conditions as the data element 'scaMethods'\n\t \ * 'startAuthorisationWithTransactionAuthorisation':\n\t\t The link to the authorisation end-point, where the authorisation sub-resource\n\t\t has to be generated while authorising the transaction e.g. by uploading an\n\t\t OTP received by SMS.\n\t * 'self':\n\t\t The link to the payment initiation resource created by this request.\n\t\t This link can be used to retrieve the resource data.\n\t * 'status':\n\t\t The link to retrieve the transaction status of the payment initiation.\n\t * 'scaStatus':\n\t\t The link to retrieve the scaStatus of the corresponding authorisation sub-resource.\n\t\t This link is only contained, if an authorisation sub-resource has been already created." basketId: description: Resource identification of the generated signing basket resource. type: string example: 1234-basket-567 transactionStatus_SBS: description: | The transaction status is filled with codes of the ISO 20022 data table. - '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. type: string enum: - ACSC - ACTC - ACWC - RCVD - RJCT example: RCVD BasketPaymentInitResponseList: title: BasketPaymentInitResponseList type: object properties: payments: description: "" type: array items: $ref: '#/definitions/paymentIdList' transactionStatus: $ref: '#/definitions/transactionStatus_SBS' required: - payments signingBasketResponse-201: description: Body of the JSON response for a successful create signing basket request. type: object properties: transactionStatus: $ref: '#/definitions/transactionStatus_SBS' basketId: $ref: '#/definitions/basketId' scaMethods: $ref: '#/definitions/scaMethods' chosenScaMethod: $ref: '#/definitions/chosenScaMethod' challengeData: $ref: '#/definitions/challengeData' _links: $ref: '#/definitions/_linksSigningBasket' psuMessage: $ref: '#/definitions/psuMessageText' tppMessages: type: array items: $ref: '#/definitions/tppMessage2XX' OK_200_SigningBasketStatus: description: OK properties: transactionStatus: $ref: '#/definitions/transactionStatus_SBS' signingBasket: description: JSON Body of a establish signing basket request. The body shall contain at least one entry. type: object properties: paymentIds: $ref: '#/definitions/paymentIdList' consentIds: $ref: '#/definitions/consentIdList' paymentIdList: description: A list of paymentIds type: array minItems: 1 items: $ref: '#/definitions/paymentId' description: Resource identification of the generated payment initiation resource. example: 1234-wertiq-983 consentIdList: description: A list of consentIds type: array minItems: 1 items: $ref: '#/definitions/consentId' description: ID of the corresponding consent object as returned by an Account Information Consent Request. paymentId: description: Resource identification of the generated payment initiation resource. type: string example: 1234-wertiq-983 consentId: description: ID of the corresponding consent object as returned by an Account Information Consent Request. type: string authenticationObject: title: authenticationObject description: Authentication Object type: object properties: authenticationType: $ref: '#/definitions/authenticationType' authenticationVersion: description: |- Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation. 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. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. 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 authenticationType: title: authenticationType description: "Type of the authentication method.\n\nMore authentication types might be added during implementation projects and documented in the ASPSP documentation.\n\n \ - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.\n - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. \n To contact the card, the PSU normally needs a (handheld) device. \n With this device, the PSU either reads the challenging data through a visual interface like flickering or \n the PSU types in the challenge through the device key pad. \n The device then derives an OTP from the challenge data and displays the OTP to the PSU.\n - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data \n which can be read in by a consumer device or specific mobile app. \n The device resp. the specific app than derives an OTP from the visual challenge data and displays \n the OTP to the PSU.\n - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU." example: SMS_OTP type: string enum: - SMS_OTP - CHIP_OTP - PHOTO_OTP - PUSH_OTP challengeData: title: challengeData description: |- 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, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is 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 e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU. type: string chosenScaMethod: description: | This data element is only contained in the response if the APSPS has chosen the Embedded SCA Approach, if the PSU is already identified e.g. with the first relevant factor or alternatively an access token, if SCA is required and if the authentication method is implicitly selected. $ref: '#/definitions/authenticationObject' scaMethods: description: | This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body. These methods shall be presented towards the PSU for selection by the TPP. type: array items: $ref: '#/definitions/authenticationObject' _linksAll: title: _linksAll description: A _link object with all availabel 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' _linksStartScaProcess: title: _linksStartScaProcess description: |- 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. - 'scaApp2AppIOS': In case of an APP2APP Redirect Approach supported for IOS, the ASPSP is transmitting the deeplink to redirect to. - 'scaApp2AppAndroid': In case of an APP2APP Redirect Approach supported for Android, the ASPSP is transmitting the deeplink to redirect to. - '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. type: object properties: scaRedirect: $ref: '#/definitions/hrefType' scaApp2AppIOS: $ref: '#/definitions/hrefType' scaApp2AppAndroid: $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' tppMessageCategory: title: tppMessageCategory description: Category of the TPP message category example: ERROR type: string enum: - ERROR - WARNING MessageCode2XX: title: MessageCode2XX description: Message codes for HTTP Error codes 2XX. example: WARNING type: string enum: - WARNING MessageCode400_PIS: title: MessageCode400_PIS description: 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 MessageCode401_PIS: title: MessageCode401_PIS description: 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 MessageCode403_PIS: title: MessageCode403_PIS description: 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 MessageCode404_PIS: title: MessageCode404_PIS description: Message codes defined for PIS for HTTP Error code 404 (NOT FOUND). example: RESOURCE_UNKNOWN type: string enum: - RESOURCE_UNKNOWN - PRODUCT_UNKNOWN MessageCode405_PIS: title: MessageCode405_PIS description: Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED). example: SERVICE_INVALID type: string enum: - SERVICE_INVALID MessageCode405_PIS_CANC: title: MessageCode405_PIS_CANC description: 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 MessageCode409_PIS: title: MessageCode409_PIS description: Message codes defined for PIS for HTTP Error code 409 (CONFLICT). example: STATUS_INVALID type: string enum: - STATUS_INVALID MessageCode400_SBS: title: MessageCode400_SBS description: 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 - EXECUTION_DATE_INVALID MessageCode401_SBS: title: MessageCode401_SBS description: 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 MessageCode403_SBS: title: MessageCode403_SBS description: 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 MessageCode404_SBS: title: MessageCode404_SBS description: Message codes defined for PIS for HTTP Error code 404 (NOT FOUND). example: RESOURCE_UNKNOWN type: string enum: - RESOURCE_UNKNOWN MessageCode405_SBS: title: MessageCode405_SBS description: Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED). example: SERVICE_INVALID type: string enum: - SERVICE_INVALID MessageCode409_SBS: title: MessageCode409_SBS description: Message codes defined for PIS for HTTP Error code 409 (CONFLICT). example: STATUS_INVALID type: string enum: - REFERENCE_STATUS_INVALID - STATUS_INVALID tppMessage2XX: 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 tppMessage400_PIS: 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 tppMessage401_PIS: 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 tppMessage403_PIS: 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 tppMessage404_PIS: 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 tppMessage405_PIS: 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 tppMessage405_PIS_CANC: 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 tppMessage409_PIS: 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 tppMessage400_SBS: 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 tppMessage401_SBS: 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 tppMessage403_SBS: 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 tppMessage404_SBS: title: tppMessage404_SBS type: object properties: category: $ref: '#/definitions/tppMessageCategory' code: $ref: '#/definitions/MessageCode404_SBS' path: type: string text: description: Additional explaining text to the TPP. type: string maxLength: 512 required: - category - code tppMessage405_SBS: title: tppMessage405_SBS type: object properties: category: $ref: '#/definitions/tppMessageCategory' code: $ref: '#/definitions/MessageCode405_SBS' path: type: string text: description: Additional explaining text to the TPP. type: string maxLength: 512 required: - category - code tppMessage409_SBS: 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 Error400_PIS: title: Error400_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError' _links: $ref: '#/definitions/_linksAll' required: - type - code Error401_PIS: title: Error401_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError1' _links: $ref: '#/definitions/_linksAll' required: - type - code Error403_PIS: title: Error403_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError2' _links: $ref: '#/definitions/_linksAll' required: - type - code Error404_PIS: title: Error404_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError3' _links: $ref: '#/definitions/_linksAll' required: - type - code Error405_PIS: title: Error405_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError4' _links: $ref: '#/definitions/_linksAll' required: - type - code Error405_PIS_CANC: title: Error405_PIS_CANC description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError5' _links: $ref: '#/definitions/_linksAll' required: - type - code Error409_PIS: title: Error409_PIS description: "Standardised definition of reporting error information according to [RFC7807] \nin 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. Might be used if more than one error is to be communicated type: array items: $ref: '#/definitions/AdditionalError6' _links: $ref: '#/definitions/_linksAll' required: - type - code Error400_NG_PIS: title: Error400_NG_PIS description: | 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' Error401_NG_PIS: title: Error401_NG_PIS description: | 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' Error403_NG_PIS: title: Error403_NG_PIS description: | 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' Error404_NG_PIS: title: Error404_NG_PIS description: | 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' Error405_NG_PIS: title: Error405_NG_PIS description: | NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 405. type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage405_PIS' _links: $ref: '#/definitions/_linksAll' Error405_NG_PIS_CANC: title: Error405_NG_PIS_CANC description: | 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' Error409_NG_PIS: title: Error409_NG_PIS description: 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' Error400_NG_SBS: title: Error400_NG_SBS description: | 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_SBS' _links: $ref: '#/definitions/_linksAll' Error401_NG_SBS: title: Error401_NG_SBS description: | 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_SBS' _links: $ref: '#/definitions/_linksAll' Error403_NG_SBS: title: Error403_NG_SBS description: | 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_SBS' _links: $ref: '#/definitions/_linksAll' Error404_NG_SBS: title: Error404_NG_SBS description: | 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_SBS' _links: $ref: '#/definitions/_linksAll' Error405_NG_SBS: title: Error405_NG_SBS description: | NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 405. type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage405_SBS' _links: $ref: '#/definitions/_linksAll' Error409_NG_SBS: title: Error409_NG_SBS description: | NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401. type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage409_SBS' _links: $ref: '#/definitions/_linksAll' AdditionalError: title: AdditionalError description: 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 AdditionalError1: title: AdditionalError1 description: 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 AdditionalError2: title: AdditionalError2 description: 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 AdditionalError3: title: AdditionalError3 description: 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 AdditionalError4: title: AdditionalError4 description: 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 cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED). example: SERVICE_INVALID type: string default: SERVICE_INVALID required: - code AdditionalError5: title: AdditionalError5 description: 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_CANC' required: - code AdditionalError6: title: AdditionalError6 description: 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 type: string default: STATUS_INVALID required: - code OtpFormat: title: OtpFormat description: The format type of the OTP to be typed in. The admitted values are "characters" or "integer". example: characters type: string enum: - characters - integer hrefType: description: Link to a resource type: object properties: href: $ref: '#/definitions/hrefEntry' hrefEntry: description: Link to a resource type: string example: /v1/payments/sepa-credit-transfers/1234-wertiq-983 scaStatusResponse: title: scaStatusResponse description: Body of the JSON response with SCA Status type: object properties: scaStatus: $ref: '#/definitions/scaStatus' scaStatus: title: scaStatus description: "This data element is containing information about the status of the SCA method applied. \n\nThe following codes are defined for this data type.\n\n \ * 'received':\n An authorisation or cancellation-authorisation resource has been created successfully.\n * 'psuIdentified':\n The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n \ * 'psuAuthenticated':\n 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.\n * 'scaMethodSelected':\n The PSU/TPP has selected the related SCA routine. \n If the SCA method is chosen implicitly since only one SCA method is available, \n then this is the first status to be reported instead of 'received'.\n * 'started':\n The addressed SCA routine has been started.\n \ * 'finalised':\n The SCA routine has been finalised successfully.\n * 'failed':\n The SCA routine failed\n * 'exempted':\n 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 authorisations: title: authorisations description: An array of all authorisationIds type: object properties: authorisationIds: description: An array of all authorisationIds type: array items: type: string required: - authorisationIds startScaprocessResponse: title: startScaprocessResponse description: 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 authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body. These 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 tags: [] externalDocs: url: https://www.berlin-group.org/nextgenpsd2-downloads description: | Full Documentation of NextGenPSD2 Access to Account Interoperability Framework (General Introduction Paper, Operational Rules, Implementation Guidelines) x-ibm-endpoints: - endpointUrl: https://api-mtls-sandbox.rba.hr type: - production - development ...