--- swagger: "2.0" info: x-ibm-name: psd2-payments-api-132 title: Payments API version: 1.3.2 description: "" schemes: - https basePath: /psd2-payments-api-1.3.2/v1 consumes: - application/json produces: - application/json securityDefinitions: clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] paths: /{payment-service}/{payment-product}/{paymentId}/status: get: description: Check the transaction status of a payment initiation. summary: Payment initiation status request tags: - Payment Initiation Service (PIS) operationId: getPaymentInitiationStatus produces: - application/json parameters: - name: payment-service type: string required: true in: path enum: - payments - periodic-payments - bulk-payments - name: payment-product type: string required: true in: path enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-bgn - domestic-budget-transfers-bgn - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - pain001-credit-transfers-hr - name: paymentId type: string required: true in: path - 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 headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/OK_200_PaymentInitiationStatus' 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 /payments/{payment-product}/{paymentId}: get: description: Returns the content of a payment object. summary: Get Payment Information tags: - Payment Initiation Service (PIS) operationId: getPaymentInformationSingle produces: - application/json parameters: - name: payment-product type: string required: true in: path enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-bgn - domestic-budget-transfers-bgn - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId type: string required: true in: path description: Resource identification of the generated payment 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. 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 headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/paymentInitiationWithStatusResponse' 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 /periodic-payments/{payment-product}/{paymentId}: get: description: Returns the content of a payment object. summary: Get Payment Information tags: - Payment Initiation Service (PIS) operationId: getPaymentInformationPeriodoc produces: - application/json parameters: - name: payment-product type: string required: true in: path enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-bgn - domestic-budget-transfers-bgn - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId type: string required: true in: path description: Resource identification of the generated payment 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. 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 headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/periodicPaymentInitiationWithStatusResponse' 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 /bulk-payments/{payment-product}/{paymentId}: get: description: Returns the content of a payment object. summary: Get Payment Information tags: - Payment Initiation Service (PIS) operationId: getPaymentInformationBulk produces: - application/json - application/xml parameters: - name: payment-product type: string required: true in: path enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-bgn - domestic-budget-transfers-bgn - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - pain001-credit-transfers-hr - name: paymentId type: string required: true in: path description: Resource identification of the generated payment 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. 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 headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: $ref: '#/definitions/bulkPaymentInitiationWithStatusResponse' 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 /{payment-service}/{payment-product}/{paymentId}: delete: summary: Payment Cancellation Request description: | This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message. Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day). The response to this DELETE command will tell the TPP whether the * access method was rejected * access method was successful, or * access method is generally applicable, but further authorisation processes are needed. operationId: cancelPayment tags: - Payment Initiation Service (PIS) produces: - application/json parameters: - name: payment-service type: string required: true in: path enum: - payments - periodic-payments - bulk-payments - name: payment-product type: string required: true in: path enum: - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - domestic-credit-transfers-bgn - domestic-budget-transfers-bgn - pain001-credit-transfers-hr - name: paymentId type: string required: true in: path description: Resource identification of the generated payment 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. 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: 202: description: Received headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 schema: type: object example: transactionStatus: RCVD _links: [] 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_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 /{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}: get: description: This method returns the SCA status of a payment initiation's authorisation sub-resource. summary: Get Authorisation Sub-Resource tags: - Authorisation Sub-Resource operationId: getAuthorisationSubresource deprecated: false produces: - application/json parameters: - name: payment-service in: path required: true enum: - payments - bulk-payments - periodic-payments type: string description: |- Possible values are: * payments * bulk-payments * periodic-payments - name: payment-product in: path required: true enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments type: string description: |- 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: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId in: path required: true type: string description: Resource identification of the generated payment initiation resource. - 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. - 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_PIS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsupported Media Type 429: description: Too Many Requests 503: description: Service Unavailable default: description: Internal Server Error /{payment-service}/{payment-product}/{paymentId}/authorisations: get: description: Read a list of all authorisation subresources IDs which have been created. summary: Get List Authorisation Sub-Resources tags: - List Authorisation Sub-Resources operationId: getListAuthorisationSubresources deprecated: false produces: - application/json parameters: - name: payment-service in: path required: true enum: - payments - bulk-payments - periodic-payments type: string description: |- Possible values are: * payments * bulk-payments * periodic-payments - name: payment-product in: path required: true enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments type: string description: |- 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: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId in: path required: true type: string description: Resource identification of the generated payment 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. - 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_PIS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsupported Media Type 429: description: Too Many Requests 503: description: Service Unavailable default: description: Internal Server Error post: description: Create an authorisation sub-resource and start the authorisation process. summary: Post Authorisation Sub-Resource tags: - Post Authorisation Sub-Resource operationId: postAuthorisationSubresource deprecated: false produces: - application/json parameters: - name: payment-service in: path required: true enum: - payments - bulk-payments - periodic-payments type: string description: |- Possible values are: * payments * bulk-payments * periodic-payments - name: payment-product in: path required: true enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments type: string description: |- 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: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId in: path required: true type: string description: Resource identification of the generated payment 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: 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 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 documentation. Only used in a corporate context. - 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. 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. - 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: TPP-Notification-URI in: header required: false type: string description: URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. - name: TPP-Notification-Content-Preferred in: header required: false type: string description: 'SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.' - 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-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: Body of the JSON response for a Start SCA authorisation request. 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_PIS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsupported Media Type 429: description: Too Many Requests 503: description: Service Unavailable default: description: Internal Server Error /{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations: post: description: Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. summary: Post Authorisation Cancellation tags: - Post Authorisation Cancellation operationId: postAuthorisationCancellation deprecated: false produces: - application/json parameters: - name: payment-service in: path required: true enum: - payments - bulk-payments - periodic-payments type: string description: |- Possible values are: * payments * bulk-payments * periodic-payments - name: payment-product in: path required: true enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments type: string description: |- 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: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId in: path required: true type: string description: Resource identification of the generated payment 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. - 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 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 documentation. Only used in a corporate context. - 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. 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. - 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: TPP-Notification-URI in: header required: false type: string description: URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. - name: TPP-Notification-Content-Preferred in: header required: false type: string description: 'SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.' - 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: 201: description: Body of the JSON response for a Start SCA authorisation request. 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_PIS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsupported Media Type 429: description: Too Many Requests 503: description: Service Unavailable default: description: Internal Server Error get: description: Retrieve a list of all created cancellation authorisation sub-resources. summary: Get Cancellation Authorisation Information tags: - Get Cancellation Authorisation Information operationId: getAuthorisationCancellationInformation deprecated: false produces: - application/json parameters: - name: payment-service in: path required: true enum: - payments - bulk-payments - periodic-payments type: string description: |- Possible values are: * payments * bulk-payments * periodic-payments - name: payment-product in: path required: true enum: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments type: string description: |- 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: - domestic - sepa-credit-transfers - cross-border-credit-transfers - domestic-credit-transfers-hr - hr-rtgs-payments - target-2-payments - name: paymentId in: path required: true type: string description: Resource identification of the generated payment 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. - 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: type: array items: type: string headers: X-Request-ID: type: string default: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 400: description: Bad Request schema: $ref: '#/definitions/Error400_NG_PIS' 401: description: Unauthorized schema: $ref: '#/definitions/Error401_NG_PIS' 403: description: Forbidden schema: $ref: '#/definitions/Error403_NG_PIS' 404: description: Not found schema: $ref: '#/definitions/Error404_NG_PIS' 405: description: Method Not Allowed schema: $ref: '#/definitions/Error405_NG_PIS' 406: description: Not Acceptable 408: description: Request Timeout 409: description: Conflict schema: $ref: '#/definitions/Error409_NG_PIS' 415: description: Unsupported Media Type 429: description: Too Many Requests 503: description: Service Unavailable default: description: Internal Server Error definitions: paymentInitiationWithStatusResponse: description: | Generic JSON response body consistion of the corresponding payment initation JSON body together with an optional transaction status field. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName properties: transactionStatus: $ref: '#/definitions/transactionStatus' endToEndIdentification: type: string maxLength: 35 instructedAmount: $ref: '#/definitions/amount' debtorAccount: $ref: '#/definitions/accountReference' creditorAccount: $ref: '#/definitions/accountReference' creditorName: $ref: '#/definitions/creditorName' creditorAddress: $ref: '#/definitions/address' creditorAgent: $ref: '#/definitions/bicfi' remittanceInformationUnstructured: $ref: '#/definitions/remittanceInformationUnstructured' remittanceInformationStructured: type: string creditorAgentName: type: string chargeBearer: $ref: '#/definitions/ChargeBearer' serviceLevel: $ref: '#/definitions/ServiceLevel' requestedExecutionDate: description: '{DATE}' example: "2015-05-05" type: string format: date purposeCode: type: string example: S00014 ultimateCreditor: type: string ultimateDebtor: type: string periodicPaymentInitiationWithStatusResponse: description: | Generic JSON response body consistion of the corresponding periodic payment initation JSON body together with an optional transaction status field. type: object required: - debtorAccount - instructedAmount - creditorAccount - creditorName - startDate - frequency properties: endToEndIdentification: type: string maxLength: 35 debtorAccount: $ref: '#/definitions/accountReference' instructedAmount: $ref: '#/definitions/amount' creditorAccount: $ref: '#/definitions/accountReference' creditorAgent: $ref: '#/definitions/bicfi' creditorName: $ref: '#/definitions/creditorName' creditorAddress: $ref: '#/definitions/address' remittanceInformationUnstructured: $ref: '#/definitions/remittanceInformationUnstructured' remittanceInformationStructured: type: string creditorAgentName: type: string chargeBearer: $ref: '#/definitions/ChargeBearer' serviceLevel: $ref: '#/definitions/ServiceLevel' requestedExecutionDate: description: '{DATE}' example: "2015-05-05" type: string format: date purposeCode: type: string example: S00014 ultimateCreditor: type: string ultimateDebtor: type: string startDate: $ref: '#/definitions/startDate' endDate: $ref: '#/definitions/endDate' executionRule: $ref: '#/definitions/executionRule' frequency: $ref: '#/definitions/frequencyCode' dayOfExecution: $ref: '#/definitions/dayOfExecution' transactionStatus: $ref: '#/definitions/transactionStatus' bulkPaymentInitiationWithStatusResponse: description: | Generic JSON response body consistion of the corresponding bulk payment initation JSON body together with an optional transaction status field. type: object required: - payments - debtorAccount properties: batchBookingPreferred: $ref: '#/definitions/batchBookingPreferred' requestedExecutionDate: type: string format: date debtorAccount: $ref: '#/definitions/accountReference' payments: description: | A list of generic JSON bodies payment initations for bulk payments via JSON. type: array items: $ref: '#/definitions/paymentInitiationBulkElement_json' transactionStatus: $ref: '#/definitions/transactionStatus' paymentInitiationBulkElement_json: type: object required: - instructedAmount - creditorAccount - creditorName properties: endToEndIdentification: type: string maxLength: 35 instructedAmount: $ref: '#/definitions/amount' debtorAccount: $ref: '#/definitions/accountReference' creditorAccount: $ref: '#/definitions/accountReference' creditorName: $ref: '#/definitions/creditorName' creditorAddress: $ref: '#/definitions/address' creditorAgent: $ref: '#/definitions/bicfi' remittanceInformationUnstructured: $ref: '#/definitions/remittanceInformationUnstructured' remittanceInformationStructured: type: string creditorAgentName: type: string chargeBearer: $ref: '#/definitions/ChargeBearer' serviceLevel: $ref: '#/definitions/ServiceLevel' requestedExecutionDate: description: '{DATE}' example: "2015-05-05" type: string format: date purposeCode: type: string example: S00014 ultimateCreditor: type: string ultimateDebtor: type: string accountReference: description: | 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: $ref: '#/definitions/iban' bban: $ref: '#/definitions/bban' currency: $ref: '#/definitions/currencyCode' debtorName: type: string dayOfExecution: description: | Day of execution as string. This string consists of up two characters. Leading zeroes are not allowed. 31 is ultimo of the month. type: string maxLength: 2 enum: - "1" - "2" - "3" - "4" - "5" - "6" - "7" - "8" - "9" - "10" - "11" - "12" - "13" - "14" - "15" - "16" - "17" - "18" - "19" - "20" - "21" - "22" - "23" - "24" - "25" - "26" - "27" - "28" - "29" - "30" - "31" ChargeBearer: title: chargeBearer example: CRED x-enum-elements: - name: CRED description: "" - name: DEBT description: "" - name: SHAR description: "" - name: SLEV description: "" type: string enum: - CRED - DEBT - SHAR ServiceLevel: title: Service level according to ISO 20022 example: SEPA type: string enum: - SEPA - URGP - SDVA - NEXT - SPOT - NURG iban: type: string description: IBAN of an account. pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}' example: FR7612345987650123456789014 bban: description: | Basic Bank Account Number (BBAN) Identifier. This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN). Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer. type: string pattern: '[a-zA-Z0-9]{1,30}' example: BARC12345612345678 amount: type: object required: - currency - amount properties: currency: $ref: '#/definitions/currencyCode' amount: $ref: '#/definitions/amountValue' example: currency: EUR amount: "123" amountValue: type: string pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? example: "5877.78" bicfi: description: | BICFI type: string pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' example: AAAADEBBXXX creditorName: description: Creditor name. type: string maxLength: 70 example: Creditor Name creditorAgentName: description: Creditor agent name. type: string maxLength: 70 example: Creditor Agent Name batchBookingPreferred: description: | If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions. The ASPSP will follow this preference according to contracts agreed on with the PSU. type: boolean example: false address: type: object required: - country properties: street: type: string maxLength: 70 buildingNumber: type: string city: type: string postalCode: type: string country: $ref: '#/definitions/countryCode' example: street: rue blue buildingnNumber: "89" city: Paris postalCode: "75000" country: FR remittanceInformationUnstructured: description: | Unstructured remittance information. type: string maxLength: 140 example: Ref Number Merchant startDate: description: | The first applicable day of execution starting from this date is the first payment. type: string format: date endDate: description: | The last applicable day of execution. If not given, it is an infinite standing order. type: string format: date countryCode: description: ISO 3166 ALPHA2 country code. type: string pattern: '[A-Z]{2}' example: SE executionRule: description: | "following" or "preceding" supported as values. This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. type: string enum: - following - preceding frequencyCode: type: string enum: - Daily - Weekly - EveryTwoWeeks - Monthly - EveryTwoMonths - Quarterly - SemiAnnual - Annual - MonthlyVariable 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. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. 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 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 currencyCode: description: | ISO 4217 Alpha 3 currency code. type: string pattern: '[A-Z]{3}' example: EUR 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. 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 transactionStatus: description: | The transaction status is filled with codes of the ISO 20022 data table: - 'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed. - 'ACCP': 'AcceptedCustomerProfile' - Preceding check of technical validation was successful. Customer profile check was also successful. - 'ACSC': 'AcceptedSettlementCompleted' - Settlement on the debtor´┐Żs account has been completed. **Usage:** this can be used by the first agent to report to the debtor that the transaction has been completed. **Warning:** this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement. - 'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. - 'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful. - 'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent. - 'ACWP': 'AcceptedWithoutPosting' - Payment instruction included in the credit transfer is accepted without being posted to the creditor customer account. - 'RCVD': 'Received' - Payment initiation has been received by the receiving agent. - 'PDNG': 'Pending' - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed. - 'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected. - 'CANC': 'Cancelled' Payment initiation has been cancelled before execution Remark: This codeis accepted as new code by ISO20022. - 'ACFC': 'AcceptedFundsChecked' - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive . Remark: This code is accepted as new code by ISO20022. - 'PATC': 'PartiallyAcceptedTechnical' Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful. Remark: This code is accepted as new code by ISO20022. - 'PART': 'PartiallyAccepted' - A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected. type: string enum: - ACCC - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - RCVD - PDNG - RJCT - CANC - ACFC - PATC - PART example: ACCP tppMessageCategory: title: tppMessageCategory description: Category of the TPP message category example: ERROR type: string enum: - ERROR - WARNING _linksAll: title: _linksAll description: A _link object with all availabel link types type: object properties: scaRedirect: $ref: '#/definitions/hrefType' scaApp2AppIOS: $ref: '#/definitions/hrefType' scaApp2AppAndroid: $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, the ASPSP is transmitting the link to which to redirect the PSU mobile device. - 'scaApp2AppAndroid': In case of an App2App Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU mobile device. - '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' 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 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 OK_200_PaymentInitiationStatus: description: Body of the response for a successful payment initiation status request in case of an JSON based endpoint. type: object required: - transactionStatus properties: transactionStatus: $ref: '#/definitions/transactionStatus' fundsAvailable: type: boolean 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 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 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 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' 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' tags: - name: Payment Initiation Service (PIS) description: | The Decription for Payment Initiation Service (PIS) offers the following services: * Initiation and update of a payment request * Status information of a payment - name: Common Services description: |- Processes on starting authorisations, update PSU identification or PSU authentication data and explicit authorisation of transactions by using SCA are very similar in PIS and AIS services. The API calls supporting these processes are described in the following independently from the service/endpoint. For reasons of clarity, the endpoints are defined always for the Payment Initiation Service, the Payment Cancellation, the Account Information Service (Consents). These processes usually are used following a hyperlink of the ASPSP. 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-configuration: testable: true enforced: true phase: realized x-ibm-endpoints: - endpointUrl: https://api-mtls-sandbox.rba.hr type: - production - development ...