--- swagger: "2.0" info: x-ibm-name: psd2-berlin-request-to-pay-services contact: name: The Berlin Group - A European Standards Initiative url: https://www.berlin-group.org/ email: info@berlin-group.org description: "# Endpoints url \ndiscount sandbox \nhttps://mtls-api-nonprod.discountbank.co.il/devapi/cert\n\ndiscount prod \nhttps://mtls-api.discountbank.co.il/prod/d\n\nmercantile sandbox \ \nhttps://mtls-api-nonprod.mercantile.co.il/devapi/cert\n\nmercantile prod \nhttps://mtls-api.mercantile.co.il/prod/d\n\n# Summary\nA Request to Pay scheme (RTP scheme) defines rules, messages and data sets for the exchange of a Request to Pay message (RTP message) from an originator to a receiver.\nWith the Request to Pay Services of the openFinance API Framework, a service provider can use its openFinance API to receive RTP messages and to inform the sender \nabout the status of the corresponding RTP transaction as well as potentially the status of the related payment. " license: name: Creative Commons Attribution 4.0 International Public License url: https://creativecommons.org/licenses/by/4.0/ title: PSD2 BERLIN Request to Pay Services version: "2.1" name: "" schemes: - https basePath: /psd2 consumes: - application/json produces: - application/json security: [] x-ibm-configuration: enforced: true testable: true phase: realized paths: /v2.1/requests-for-payments/{payment-product}: post: consumes: - application/json produces: - application/json summary: Submits a request to pay transaction. description: | Submits a request to pay transaction. operationId: initiateRequestToPay tags: - Request to Pay (RTP) API security: - [] parameters: - description: "The addressed payment product, e.g. for SEPA Credit Transfers (SCT). \nThe default list of products for RTP supported in this standard is:\n -- masav\n -- zahav\n -- fp\n -- swift\nThe ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client.\nFor definitions of basic non euro generic products see [XS2A-DP].\nFurther products might be published by the ASPSP within its openFinance API documentation. \n" in: path name: payment-product required: true type: string enum: - masav - zahav - fp - swift - description: "When API Client include a signature according to this signature profile, they also must include a \\\"Digest\\\" header as defined in [RFC3230]. \nThe \\\"Digest\\\" Header contains a Hash of the message body. If the message does not contain a body, the \\\"Digest\\\" header must contain the hash of an empty byte list.\nThe only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843].\n" in: header name: Digest type: string required: true x-example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= - description: ID of the request, unique to the call, as determined by the initiating party. in: header required: true name: X-Request-ID type: string format: uuid x-example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 - description: | The attribute x-jws-signature contains the JSON Web Signature. in: header name: x-jws-signature type: string required: true x-example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 - description: | Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service. in: header name: API-Contract-ID type: string required: true x-example: Regulation - description: | Request body for a RTP request. in: body name: body schema: $ref: '#/definitions/SinglePayment_RTP_SCT' required: true responses: 201: description: Created headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: | The name of the Implementation Guideline document, where the service is based on, e.g. \"Extended Payment Initiation Services\". type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean ASPSP-Notification-Content: description: | The string has the form status=X1, …, Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the following semantics SCA - Notification on every change of the scaStatus attribute for all related authorisation processes is provided by the ASPSP for the related resource. PROCESS - Notification on all changes of consentStatus or transactionStatus attributes is provided by the ASPSP for the related resource LAST - Notification on the last consentStatus or transactionStatus as available in the XS2A interface is provided by the ASPSP for the related resource. This field must be provided if the ASPSP-Notification-Support=true. The ASPSP might consider the notification content as preferred by the TPP, but can also respond independently of the preferred request type: string Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Timestamp: description: | Timestamp of the response from the Receiver-RTPSP. Mandatory, if the API Server is not in the role of the Receiver-RTPSP (with regards to this specific request). Otherwise optional. Remark: The date and time of the response that comes directly from the Receiver-RTPSP is already provided in the date header. type: string schema: $ref: '#/definitions/rtpResponse-201' 400: description: Bad Request headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean 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 schema: $ref: '#/definitions/error_NG_400_RTP' 401: description: Unauthorized headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_401_RTP' 403: description: Forbidden headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_403_RTP' 404: description: Not found headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_404_RTP' 405: description: Method Not Allowed headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_405_RTP' 406: description: Not Acceptable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 408: description: Request Timeout headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 409: description: Conflict headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_409_RTP' 415: description: Unsupported Media Type headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 500: description: Internal Server Error headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 503: description: Service Unavailable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string /v2.1/requests-for-payments/{payment-product}/{paymentId}/status: get: summary: Get Transaction Status Request description: | Reads the status of an RTP initiation. operationId: requestToPay-any:get_requestToPay_status tags: - Request to Pay (RTP) API security: - [] parameters: - name: payment-product in: path description: "The addressed payment product, e.g. for SEPA Credit Transfers (SCT). \nThe default list of products for RTP supported in this standard is:\n -- masav\n -- zahav\n -- fp\n -- swift\nThe ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client.\nFor definitions of basic non euro generic products see [XS2A-DP].\nFurther products might be published by the ASPSP within its openFinance API documentation. \n" required: true type: string enum: - masav - zahav - fp - swift - name: paymentId in: path description: Resource identification of the related payment. required: true type: string maxLength: 70 x-example: fe7552ee-0728-4bd1-baf7-94942331e478 - name: Digest in: header description: "When API Client include a signature according to this signature profile, they also must include a \\\"Digest\\\" header as defined in [RFC3230]. \nThe \\\"Digest\\\" Header contains a Hash of the message body. If the message does not contain a body, the \\\"Digest\\\" header must contain the hash of an empty byte list.\nThe only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843]. \n" type: string required: true x-example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= - name: x-jws-signature in: header description: | The attribute x-jws-signature contains the JSON Web Signature. type: string required: true x-example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true type: string format: uuid x-example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 responses: 200: description: OK headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Timestamp: description: | Timestamp of the response from the Receiver-RTPSP. Mandatory, if the API Server is not in the role of the Receiver-RTPSP (with regards to this specific request). Otherwise optional. Remark: The date and time of the response that comes directly from the Receiver-RTPSP is already provided in the date header. type: string schema: $ref: '#/definitions/getRTPStatusResponse-200' 400: description: Bad Request headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean 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 schema: $ref: '#/definitions/error_NG_400_RTP' 401: description: Unauthorized headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_401_RTP' 403: description: Forbidden headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_403_RTP' 404: description: Not found headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_404_RTP' 405: description: Method Not Allowed headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_405_RTP' 406: description: Not Acceptable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 408: description: Request Timeout headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 409: description: Conflict headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_409_RTP' 415: description: Unsupported Media Type headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 500: description: Internal Server Error headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 503: description: Service Unavailable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string /v2.1/requests-for-payments/{payment-product}/{paymentId}: get: summary: Get Request to Pay Request description: | Returns the content of a request to pay object. operationId: requestToPay-valid:get_requestToPay tags: - Request to Pay (RTP) API security: - [] parameters: - name: payment-product in: path description: "The addressed payment product, e.g. for SEPA Credit Transfers (SCT). \nThe default list of products for RTP supported in this standard is:\n -- masav\n -- zahav\n -- fp\n -- swift\nThe ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client.\nFor definitions of basic non euro generic products see [XS2A-DP].\nFurther products might be published by the ASPSP within its openFinance API documentation. \n" required: true type: string enum: - masav - zahav - fp - swift - name: paymentId in: path description: Resource identification of the related payment. required: true type: string maxLength: 70 x-example: fe7552ee-0728-4bd1-baf7-94942331e478 - name: Digest in: header description: "When API Client include a signature according to this signature profile, they also must include a \\\"Digest\\\" header as defined in [RFC3230]. \nThe \\\"Digest\\\" Header contains a Hash of the message body. If the message does not contain a body, the \\\"Digest\\\" header must contain the hash of an empty byte list.\nThe only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843]. \n" type: string required: true x-example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= - name: x-jws-signature in: header description: | The attribute x-jws-signature contains the JSON Web Signature. type: string required: true x-example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true type: string format: uuid x-example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 responses: 200: description: OK headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/getRTPResponse-200' 400: description: Bad Request headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean 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 schema: $ref: '#/definitions/error_NG_400_RTP' 401: description: Unauthorized headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_401_RTP' 403: description: Forbidden headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_403_RTP' 404: description: Not found headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_404_RTP' 405: description: Method Not Allowed headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_405_RTP' 406: description: Not Acceptable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 408: description: Request Timeout headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 409: description: Conflict headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_409_RTP' 415: description: Unsupported Media Type headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 500: description: Internal Server Error headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 503: description: Service Unavailable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string delete: summary: Request to Pay Cancellation Request description: | It initiates the cancellation of a request to pay. operationId: cancelRequestToPay tags: - Request to Pay (RTP) API security: - [] parameters: - name: payment-product in: path description: "The addressed payment product, e.g. for SEPA Credit Transfers (SCT). \nThe default list of products for RTP supported in this standard is:\n -- masav\n -- zahav\n -- fp\n -- swift\nThe ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client.\nFor definitions of basic non euro generic products see [XS2A-DP].\nFurther products might be published by the ASPSP within its openFinance API documentation. \n" required: true type: string enum: - masav - zahav - fp - swift - name: paymentId in: path description: Resource identification of the related payment. required: true type: string maxLength: 70 x-example: fe7552ee-0728-4bd1-baf7-94942331e478 - name: Digest in: header description: "When API Client include a signature according to this signature profile, they also must include a \\\"Digest\\\" header as defined in [RFC3230]. \nThe \\\"Digest\\\" Header contains a Hash of the message body. If the message does not contain a body, the \\\"Digest\\\" header must contain the hash of an empty byte list.\nThe only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843]. \n" type: string required: true x-example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= - name: x-jws-signature in: header description: | The attribute x-jws-signature contains the JSON Web Signature. type: string required: true x-example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true type: string format: uuid x-example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 responses: 204: description: NO CONTENT headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 400: description: Bad Request headers: X-Reference-API-Name: description: Berlin Group openFinance API type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean 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 schema: $ref: '#/definitions/error_NG_400_RTP' 401: description: Unauthorized headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_401_RTP' 403: description: Forbidden headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_403_RTP' 404: description: Not found headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_404_RTP' 405: description: Method Not Allowed headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_405_RTP' 406: description: Not Acceptable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 408: description: Request Timeout headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 409: description: Conflict headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string schema: $ref: '#/definitions/error_NG_409_RTP' 415: description: Unsupported Media Type headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 500: description: Internal Server Error headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string 503: description: Service Unavailable headers: X-Reference-API-Name: description: "\\\"Berlin Group openFinance API\\\" \n" type: string X-Reference-API-Document: description: "The name of the Implementation Guideline document, where the service is based on, e.g. \\\"Extended Payment Initiation Services\\\". \n" type: string X-Reference-API-Version: description: ID of the request, unique to the call, as determined by the initiating party. type: string ASPSP-Notification-Support: description: | true if the ASPSP supports resource status notification services. false if the ASPSP supports resource status notification in general, but not for the current request. Not used, if resource status notification services are generally not supported by the ASPSP. Shall be supported if the ASPSP supports resource status notification services. type: boolean Location: description: | Location of the created resource. type: string X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string definitions: getRTPResponse-200: type: object required: - paymentId - transactionStatus - requestStatus - _links properties: paymentId: description: | resource identification of the generated payment initiation resource. allOf: - $ref: '#/definitions/Max70Text' transactionStatus: description: | The status of the related payment. "pending" is used if the payment could not yet be checked or submitted. allOf: - $ref: '#/definitions/TransactionStatus' requestStatus: description: | The status of the related request to pay transaction. allOf: - $ref: '#/definitions/RequestStatus' reasonCode: description: "Additional information on the reason for e.g. rejecting the request \n" allOf: - $ref: '#/definitions/StatusReasonCode' reasonProprietary: description: "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n" allOf: - $ref: '#/definitions/Max35Text' transactionFees: description: "Might be used by the ASPSP to transport the total transaction fee relevant in case of an\nunderlying payment initiation service. This field includes the entry of the \ncurrencyConversionFees if applicable. \n" allOf: - $ref: '#/definitions/amount' currencyConversionFees: description: "Might be used by the ASPSP to transport specific currency conversion fees related to \nthe initiated credit transfer, in case of an underlying payment initiation service.\n" allOf: - $ref: '#/definitions/amount' estimatedTotalAmount: description: "The amount which is estimated to be debted from the debtor account in case of an \nunderlying payment initiation service. \nNote: This amount includes fees.\n" allOf: - $ref: '#/definitions/amount' estimatedInterbankSettlementAmount: description: "The estimated amount to be transferred to the payee. \n" allOf: - $ref: '#/definitions/amount' transactionFeeIndicator: description: | If equals \"true\", the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals \"false\", the transaction will not involve additional specific transaction costs to the PSU unless the fee amount is given specifically in the data elements transactionFees and/or currencyConversionFees. If this data element is not used, there is no information about transaction fees unless the fee amount is given explicitly in the data element transactionFees and/or currencyConversionFees. type: boolean _links: description: "A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP \nwhen processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation \nResponse messages. These links will also be contained in the related Open API files. \nRemark: All links can be relative or full links, to be decided by the ASPSP.\n" allOf: - $ref: '#/definitions/_links_200_RTP' psuMessage: description: | Text to be displayed to the PSU. allOf: - $ref: '#/definitions/Max500Text' apiClientMessages: description: | Messages to the API Client on operational issues. type: array items: $ref: '#/definitions/clientMessageInformation' paymentIdentification: description: | Set of elements used to reference a payment instruction. allOf: - $ref: '#/definitions/paymentIdentification' paymentMethod: description: | Specifies the means of payment that will be used to move the amount of money. Usage: Only used for cross-border transactions. If no paymentMethod is explicitly stated, paymentMethod will be interpreted as **TRF** (Credit Transfer). allOf: - $ref: '#/definitions/CreditTransferPaymentMethodCode' categoryPurposeCode: description: | Specifies the high level purpose of the instruction based on a set of pre-defined categories; provided as code. allOf: - $ref: '#/definitions/CategoryPurposeCode' ultimateDebtor: description: | Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product. allOf: - $ref: '#/definitions/partyDescription1' instructedAmount: description: | Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. allOf: - $ref: '#/definitions/amount' creditorAccount: description: | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. allOf: - $ref: '#/definitions/accountReference1' creditorAgent: description: | Financial institution servicing an account for the creditor. allOf: - $ref: '#/definitions/agentDescription1' creditor: description: | Party to which an amount of money is due. allOf: - $ref: '#/definitions/partyDescription' ultimateCreditor: description: | Ultimate party to which an amount of money is due. allOf: - $ref: '#/definitions/partyDescription' purposeCode: description: | Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022. allOf: - $ref: '#/definitions/PurposeCode' purposeProprietary: description: | Specifies the purpose of the instruction in proprietary encoding allOf: - $ref: '#/definitions/Max35Text' remittanceInformationUnstructured: description: "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, \nsuch as commercial invoices in an accounts' receivable system, in an unstructured form.\n" type: array minItems: 1 maxItems: 1 items: $ref: '#/definitions/Max140Text' example: - '{"Ref Number Merchant"}' additionalRequestInformation: description: | Request related information which is not directly linked to the payment transaction. Only applicable for request to pay services and extended payment services. allOf: - $ref: '#/definitions/additionalRequestInformation' debtorAccount: description: | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. allOf: - $ref: '#/definitions/accountReference' debtor: description: | Party that owes an amount of money to the (ultimate) creditor. allOf: - $ref: '#/definitions/partyDescription' requestedExecutionDate: description: | Date at which the initiating party requests the clearing agent to process the payment. allOf: - $ref: '#/definitions/ISODate' requestedExecutionDateTime: description: | Date and time at which the initiating party requests the clearing agent to process the payment. allOf: - $ref: '#/definitions/ISODateTime' getRTPStatusResponse-200: type: object required: - transactionStatus properties: transactionStatus: description: | The status of the related payment. "pending" is used if the payment could not yet be checked or submitted. allOf: - $ref: '#/definitions/TransactionStatus' requestStatus: description: | The status of the related request to pay transaction. To be delivered by the API Server if not agreed otherwise. allOf: - $ref: '#/definitions/RequestStatus' reasonCode: description: "Additional information on the reason for e.g. rejecting the request \n" allOf: - $ref: '#/definitions/StatusReasonCode' reasonProprietary: description: "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n" allOf: - $ref: '#/definitions/Max35Text' debtorDecisionDateTime: description: | The date and time when the PSU has decided on accepting/rejecting the related request. allOf: - $ref: '#/definitions/ISODateTime' acceptedAmount: description: | Contained only if the accepted amount deviates from the instructed amount. allOf: - $ref: '#/definitions/amount' acceptanceDateTime: description: | Contained only if the agreed requested execution date deviates from the requested execution date in the request. allOf: - $ref: '#/definitions/ISODateTime' acceptedPaymentInstrument: description: | masav or zahav or fp swift. allOf: - $ref: '#/definitions/Max105Text' statusIdentification: description: | Reference added by the debtor allOf: - $ref: '#/definitions/Max35Text' psuMessage: description: | Text information for the PSU. allOf: - $ref: '#/definitions/Max500Text' rtpResponse-201: description: Body of the JSON response for a successful requests-for-payments request. properties: paymentId: description: | resource identification of the generated payment initiation resource. allOf: - $ref: '#/definitions/Max70Text' transactionStatus: description: | The status of the related payment. "pending" is used if the payment could not yet be checked or submitted. allOf: - $ref: '#/definitions/TransactionStatus' requestStatus: description: | The status of the related request to pay transaction. allOf: - $ref: '#/definitions/RequestStatus' reasonCode: description: "Additional information on the reason for e.g. rejecting the request \n" allOf: - $ref: '#/definitions/StatusReasonCode' reasonProprietary: description: "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n" allOf: - $ref: '#/definitions/Max35Text' transactionFees: description: "Might be used by the ASPSP to transport the total transaction fee relevant in case of an\nunderlying payment initiation service. This field includes the entry of the \ncurrencyConversionFees if applicable. \n" allOf: - $ref: '#/definitions/amount' currencyConversionFees: description: "Might be used by the ASPSP to transport specific currency conversion fees related to \nthe initiated credit transfer, in case of an underlying payment initiation service.\n" allOf: - $ref: '#/definitions/amount' estimatedTotalAmount: description: "The amount which is estimated to be debted from the debtor account in case of an \nunderlying payment initiation service. \nNote: This amount includes fees.\n" allOf: - $ref: '#/definitions/amount' estimatedInterbankSettlementAmount: description: "The estimated amount to be transferred to the payee. \n" allOf: - $ref: '#/definitions/amount' transactionFeeIndicator: description: | If equals \"true\", the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals \"false\", the transaction will not involve additional specific transaction costs to the PSU unless the fee amount is given specifically in the data elements transactionFees and/or currencyConversionFees. If this data element is not used, there is no information about transaction fees unless the fee amount is given explicitly in the data element transactionFees and/or currencyConversionFees. type: boolean _links: description: "A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP \nwhen processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation \nResponse messages. These links will also be contained in the related Open API files. \nRemark: All links can be relative or full links, to be decided by the ASPSP.\n" allOf: - $ref: '#/definitions/_links_201_RTP' psuMessage: description: | Text to be displayed to the PSU. allOf: - $ref: '#/definitions/Max500Text' apiClientMessages: description: | Messages to the API Client on operational issues. type: array items: $ref: '#/definitions/clientMessageInformation' required: - paymentId - transactionStatus - requestStatus - _links type: object additionalProperties: true Max2048Text: type: string maxLength: 2048 example: Text, maximum of 2048 characters. OrganisationIdentificationCode: description: "" type: string enum: - BANK - CBID - CHID - CINC - COID - CUST - DUNS - EMPL - GS1G - SREN - SRET - TXID - BDID - BOID example: BOID clientMessageInformation_401_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_401' path: type: string text: $ref: '#/definitions/Max500Text' Max500Text: type: string maxLength: 500 example: Text, maximum of 500 characters. CurrencyCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string pattern: '[A-Z]{3}' example: EUR error_NG_401_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_401_RTP' _links: $ref: '#/definitions/links' hrefType: description: | See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. type: object required: - href properties: href: description: "" type: string remittance: description: | See document \"openFinance API Framework Data Dictionary\", section \"Remittance\" for more details. type: object properties: referredDocumentInformation: description: | Set of elements used to identify the documents referred to in the remittance information. type: array items: $ref: '#/definitions/referredDocumentInformation' creditorReferenceInformation: description: | Reference information provided by the creditor to allow the identification of the underlying documents. allOf: - $ref: '#/definitions/creditorReferenceInformation' additionalRemittanceInformation: description: | Additional information to be displayed to the PSU e.g. within authorisation processes. This will not be used in related interbank payments. type: array items: $ref: '#/definitions/Max140Text' MessageCode_PushAisSpecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"Push AIS Specific Error Codes\" for more details. type: string enum: - SUBSCRIPTION_INVALID - SECONDARY_URI_NOT_SUPPORTED - MIME_TYPE_NOT_SUPPORTED - LIMIT_FOR_BALANCE_NOT_SUPPORTED - ACCOUNT_CURRENCY_NOT_MATCHING - BALANCE_TYPE_NOT_SUPPORTED example: SUBSCRIPTION_INVALID financialInstitutionIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Financial Institution Identification\" for more details. type: object properties: bicfi: description: "" allOf: - $ref: '#/definitions/BICFI' clearingSystemMemberId: description: | Information used to identify a member within a clearing system. allOf: - $ref: '#/definitions/clearingSystemMemberIdentification' name: description: | Name of the financial institution allOf: - $ref: '#/definitions/Max140Text' postalAddress: description: | Postal Address of the financial institution. allOf: - $ref: '#/definitions/postalAddress' other: description: | Unique identification of an organisation, as assigned by an institution, using an identification scheme. allOf: - $ref: '#/definitions/genericFinancialInstitutionIdentification' Max35Text: type: string maxLength: 35 example: Text, maximum of 35 characters. msisdn: description: | An alias to access a payment account via a registered mobile phone number. type: string pattern: ^[A-Za-z]{3}-\d{3}-\d{2,3}-\d{7}$ accountReference: description: | See document \"openFinance API Framework Data Dictionary\", section \"Account Reference\" for more details. type: object properties: iban: description: "" allOf: - $ref: '#/definitions/IBAN' bban: description: | BBAN of the account. This data elements is used for payment accounts which have no IBAN. allOf: - $ref: '#/definitions/BBAN' maskedPan: description: | Primary Account Number (PAN) of a card in a masked form. allOf: - $ref: '#/definitions/Max35Text' msisdn: description: | An alias to access a payment account via a registered mobile phone number. allOf: - $ref: '#/definitions/msisdn' other: description: | An alias with a proprietary coding allOf: - $ref: '#/definitions/genericAccountIdentification' typeCode: description: | Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. allOf: - $ref: '#/definitions/CashAccountType' typeProprietary: description: | Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. allOf: - $ref: '#/definitions/Max35Text' currency: description: | ISO 4217 Alpha 3 currency code allOf: - $ref: '#/definitions/CurrencyCode' IBAN: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string pattern: '[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}' example: FR7612345987650123456789014 error_NG_405_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_405_RTP' _links: $ref: '#/definitions/links' additionalRequestInformation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Additional Request Information\" for more details. type: object required: - requestedExpiryDateTime properties: paymentConditions: description: | Conditions for the execution of the payment. allOf: - $ref: '#/definitions/paymentConditions' creationDateTime: description: | creationDateTime of the originator allOf: - $ref: '#/definitions/ISODateTime' requestedExpiryDateTime: description: | Date and Time at which this request expires. allOf: - $ref: '#/definitions/ISODateTime' originatorPspId: description: | Originator payment service provider in case of indirect participation regarding a related API Access Scheme or bilateral contract allOf: - $ref: '#/definitions/financialInstitutionIdentification' receiverPspId: description: "Receiving payment service provider as defined by an API Access Scheme or bilateral contracts in case of not addressing the receiving institution directly. \nIt is mandatory in case where the technical API Provider is not the receiver as such.\n" allOf: - $ref: '#/definitions/financialInstitutionIdentification' clientMessageInformation_403_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_403' path: type: string text: $ref: '#/definitions/Max500Text' CashAccountType: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string enum: - CACC example: CACC genericAccountIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Generic Account Identification\" for more details. type: object required: - identification properties: identification: description: | Unique and unambiguous identification of an account. allOf: - $ref: '#/definitions/Max35Text' schemeNameCode: description: | An entry provided by an external ISO code list allOf: - $ref: '#/definitions/AccountIdentificationCode' schemeNameProprietary: description: | A scheme name defined in a proprietary way. allOf: - $ref: '#/definitions/Max35Text' issuer: description: | Issuer of the identification allOf: - $ref: '#/definitions/Max35Text' error_NG_403_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_403_RTP' _links: $ref: '#/definitions/links' genericOrganisationIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Generic Organisation Identification\" for more details. type: object required: - identification properties: identification: description: | Unique and unambiguous identification of an organisation. allOf: - $ref: '#/definitions/Max35Text' schemeNameCode: description: | An entry provided by an external ISO code list allOf: - $ref: '#/definitions/OrganisationIdentificationCode' schemeNameProprietary: description: | A scheme name defined in a proprietary way. allOf: - $ref: '#/definitions/Max35Text' issuer: description: | Issuer of the identification allOf: - $ref: '#/definitions/Max35Text' privateIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Private Identification\" for more details. type: object properties: others: description: "Unique identification of a person, as assigned by an institution, using an identification scheme. \nShall be used if none of the above attributes is used.\n" type: array items: $ref: '#/definitions/personIdentification' GeoLocation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Geo Location\" for more details. type: string pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} example: GEO:52.506931;13.144558 MessageCode_PisSpecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"PIS Specific HTTP Error Codes\" for more details. type: string enum: - PAYMENT_FAILED - EXECUTION_DATE_INVALID example: PAYMENT_FAILED MessageCode_PisSpecific_401: description: | See document \"openFinance API Framework Data Dictionary\", section \"PIS Specific HTTP Error Codes\" for more details. type: string enum: - KID_MISSING example: KID_MISSING partyDescription1: description: | See document \"openFinance API Framework Data Dictionary\", section \"Party Description1\" for more details. type: object properties: name: description: | Name of the party. allOf: - $ref: '#/definitions/Max140Text' Max256Text: type: string maxLength: 256 example: Text, maximum of 256 characters. organisationIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Organisation Identification\" for more details. type: object properties: anyBIC: description: | A code allocated to a business entity or to a financial institution by a Registration Authority under an international identification scheme. allOf: - $ref: '#/definitions/BICFI' lei: description: | Legal Entity Identifier. allOf: - $ref: '#/definitions/LEI' others: description: | Unique identification of an organisation, as assigned by an institution, using an identification scheme. type: array items: $ref: '#/definitions/genericOrganisationIdentification' _links_201_RTP: title: _links_201_RTP type: object properties: scaOAuth: allOf: - $ref: '#/definitions/hrefType' description: See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. confirmation: allOf: - $ref: '#/definitions/hrefType' description: See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. self: allOf: - $ref: '#/definitions/hrefType' description: See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. status: allOf: - $ref: '#/definitions/hrefType' description: See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. scaStatus: allOf: - $ref: '#/definitions/hrefType' description: See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details. accountReference1: description: | See document \"openFinance API Framework Data Dictionary\", section \"Account Reference1\" for more details. type: object properties: iban: description: "" allOf: - $ref: '#/definitions/IBAN' bban: description: | BBAN of the account. This data elements is used for payment accounts which have no IBAN. allOf: - $ref: '#/definitions/BBAN' maskedPan: description: | Primary Account Number (PAN) of a card in a masked form. allOf: - $ref: '#/definitions/Max35Text' currency: description: | ISO 4217 Alpha 3 currency code allOf: - $ref: '#/definitions/CurrencyCode' BICFI: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}' example: ECBFDEFFFIM Max140Text: type: string maxLength: 140 example: Text, maximum of 140 characters. clientMessageInformation_404_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_404' path: type: string text: $ref: '#/definitions/Max500Text' PersonIdentificationCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string enum: - ARNU - CCPT - CUST - DRLC - EMPL - NIDN - SOSE - TELE - TXID - POID example: NIDN MessageCode_ServiceUnspecific_409: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. enum: - STATUS_INVALID example: STATUS_INVALID FinancialInstitutionIdentificationCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string MessageCode_ServiceUnspecific_405: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. type: string enum: - SERVICE_INVALID example: SERVICE_INVALID ISODate: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string format: date example: "2020-01-01" MessageCode_ServiceUnspecific_404: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. type: string enum: - RESOURCE_UNKNOWN example: RESOURCE_UNKNOWN BBAN: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string MessageCode_ServiceUnspecific_403: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. type: string enum: - SERVICE_BLOCKED - CONSENT_UNKNOWN - RESOURCE_UNKNOWN - RESOURCE_EXPIRED example: SERVICE_BLOCKED MessageCode_ServiceUnspecific_401: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. type: string enum: - CERTIFICATE_INVALID - ROLE_INVALID - CERTIFICATE_EXPIRED - CERTIFICATE_BLOCKED - CERTIFICATE_REVOKED - CERTIFICATE_MISSING - CLIENT_INVALID - CLIENT_INCONSISTENT - SIGNATURE_INVALID - SIGNATURE_MISSING - PSU_CREDENTIALS_INVALID - CORPORATE_ID_INVALID - CONSENT_INVALID - CONSENT_EXPIRED - TOKEN_UNKNOWN - TOKEN_INVALID - TOKEN_EXPIRED example: CERTIFICATE_INVALID MessageCode_ServiceUnspecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details. type: string enum: - FORMAT_ERROR - PARAMETER_NOT_CONSISTENT - PARAMETER_NOT_SUPPORTED - SERVICE_INVALID - CONSENT_UNKNOWN - RESOURCE_UNKNOWN - RESOURCE_EXPIRED - RESOURCE_BLOCKED - TIMESTAMP_INVALID - PERIOD_INVALID - SCA_METHOD_UNKNOWN - SCA_INVALID example: FORMAT_ERROR referredDocumentInformation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Referred Document Information\" for more details. type: object properties: typeCode: description: | Specifies the type of referred document, provided as code. allOf: - $ref: '#/definitions/ReferredDocumentTypeCode' typeProprietary: description: | Specifies the type of referred document, provided in proprietary encoding. allOf: - $ref: '#/definitions/Max35Text' typeIssuer: description: | Issuer of the document type. allOf: - $ref: '#/definitions/Max35Text' number: description: | Unique and unambiguous identification of the referred document. allOf: - $ref: '#/definitions/Max35Text' relatedDate: description: | Date associated with the referred document. allOf: - $ref: '#/definitions/ISODate' RequestStatus: description: | See document \"openFinance API Framework Data Dictionary\", section \"Request Status\" for more details. type: string enum: - ACCP - ACWC - RCVD - PDNG - RJCT example: ACCP MessageCode_SigningBasketSpecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"Signing Basket Specific Error Codes\" for more details. type: string enum: - REFERENCE_MIX_INVALID example: REFERENCE_MIX_INVALID MessageCode_PiisSpecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"PIIS Specific Error Codes\" for more details. type: string enum: - CARD_INVALID - NO_PIIS_ACTIVATION example: CARD_INVALID TransactionStatus: description: | See document \"openFinance API Framework Data Dictionary\", section \"Transaction Status\" for more details. type: string enum: - ACCC - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - RCVD - PDNG - RJCT - CANC - ACFC - PATC - PART - PRES example: ACCC clientMessageInformation_409_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_409' path: type: string text: $ref: '#/definitions/Max500Text' Max70Text: type: string maxLength: 70 example: Text, maximum of 70 characters. SinglePayment_RTP_SCT: title: SinglePayment_RTP_SCT type: object properties: paymentIdentification: type: object allOf: - $ref: '#/definitions/paymentIdentification' - description: Set of elements used to reference a payment instruction. paymentMethod: type: object allOf: - $ref: '#/definitions/CreditTransferPaymentMethodCode' - description: |- Specifies the means of payment that will be used to move the amount of money. Usage: Only used for cross-border transactions. If no paymentMethod is explicitly stated, paymentMethod will be interpreted as **TRF** (Credit Transfer). ultimateDebtor: type: object allOf: - $ref: '#/definitions/partyDescription1' - description: Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product. instructedAmount: type: object allOf: - $ref: '#/definitions/amount' - description: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. creditorAccount: type: object allOf: - $ref: '#/definitions/accountReference' - description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. creditorAgent: type: object allOf: - $ref: '#/definitions/agentDescription1' - description: Financial institution servicing an account for the creditor. creditor: type: object allOf: - $ref: '#/definitions/partyDescription' - description: Party to which an amount of money is due. ultimateCreditor: type: object allOf: - $ref: '#/definitions/partyDescription' - description: Ultimate party to which an amount of money is due. purposeCode: type: object allOf: - $ref: '#/definitions/PurposeCode' - description: Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022. purposeProprietary: description: Specifies the purpose of the instruction in proprietary encoding type: string maxLength: 35 remittanceInformationUnstructured: description: "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, \nsuch as commercial invoices in an accounts' receivable system, in an unstructured form." example: - '{"Ref Number Merchant"}' type: array items: type: string maxLength: 140 maxLength: 140 minItems: 1 maxItems: 1 additionalRequestInformation: type: object allOf: - $ref: '#/definitions/additionalRequestInformation' - description: |- Request related information which is not directly linked to the payment transaction. Only applicable for request to pay services and extended payment services. debtorAccount: type: object allOf: - $ref: '#/definitions/accountReference' - description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. debtor: type: object allOf: - $ref: '#/definitions/partyDescription' - description: Party that owes an amount of money to the (ultimate) creditor. requestedExecutionDate: description: Date at which the initiating party requests the clearing agent to process the payment. type: string format: date requestedExecutionDateTime: description: Date and time at which the initiating party requests the clearing agent to process the payment. type: string format: date-time required: - instructedAmount - creditorAccount - creditor - remittanceInformationUnstructured - additionalRequestInformation MessageCode_SigningBasketSpecific_409: description: | See document \"openFinance API Framework Data Dictionary\", section \"Signing Basket Specific Error Codes\" for more details. type: string enum: - REFERENCE_STATUS_INVALID example: REFERENCE_STATUS_INVALID clientMessageInformation_400_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_400' path: type: string text: $ref: '#/definitions/Max500Text' links: description: | See document \"openFinance API Framework Data Dictionary\", section \"Links\" for more details. type: object properties: scaOAuth: description: | The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. allOf: - $ref: '#/definitions/hrefType' confirmation: description: "\\\"confirmation\\\": Might be added by the ASPSP if either the \\\"scaRedirect\\\" or \\\"scaOAuth\\\" hyperlink is returned in the same response message. \nThis hyperlink defines the URL to the resource which needs to be updated with \n* a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or\n* an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.\n" allOf: - $ref: '#/definitions/hrefType' self: description: "The link to the payment initiation resource created by the request itself. \nThis link can be used later to retrieve the transaction status of the payment initiation.\n" allOf: - $ref: '#/definitions/hrefType' status: description: | A link to retrieve the status of the transaction resource. allOf: - $ref: '#/definitions/hrefType' transactionfees: description: "The link is to the status resource. \nThis link is only added within the authorisation process in case fee information is available via the status resource.\n" allOf: - $ref: '#/definitions/hrefType' scaStatus: description: | A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. allOf: - $ref: '#/definitions/hrefType' account: description: | A link to the resource providing the details of one account allOf: - $ref: '#/definitions/hrefType' savingsAccount: description: | A link to the resource providing the details of a savings account. allOf: - $ref: '#/definitions/hrefType' loanAccount: description: | A link to the resource providing the details of a loan account. allOf: - $ref: '#/definitions/hrefType' balances: description: | A link to the resource providing the balance of a dedicated account. allOf: - $ref: '#/definitions/hrefType' transactions: description: | A link to the resource providing the transaction history of a dedicated account. allOf: - $ref: '#/definitions/hrefType' cardAccount: description: | A link to the resource providing the details of one card account. allOf: - $ref: '#/definitions/hrefType' cardTransactions: description: | A link to the resource providing the transaction history of a dedicated card account. allOf: - $ref: '#/definitions/hrefType' transactionDetails: description: | A link to the resource providing details of a dedicated transaction. allOf: - $ref: '#/definitions/hrefType' ibanCheck: description: | A link to the endpoint offering the addressed iban check result. allOf: - $ref: '#/definitions/hrefType' paymentInitiation: description: | A link to an initiation related to a payment resource. allOf: - $ref: '#/definitions/hrefType' securitiesAccount: description: | A link to the resource providing the details of one securitiesAccount. allOf: - $ref: '#/definitions/hrefType' positions: description: | A link to the resource providing the list of positions of one securitiesAccount. allOf: - $ref: '#/definitions/hrefType' orders: description: | A link to the resource providing the list of orders of one securitiesAccount. allOf: - $ref: '#/definitions/hrefType' orderDetails: description: | A link to the resource providing details of one specific order. allOf: - $ref: '#/definitions/hrefType' relatedOrders: description: "An array of links to request order details of related orders related to the order that is represented by the data structure containing this element \n(e.g. other orders that originated from the same order split as this order). \n" type: array items: $ref: '#/definitions/hrefType' relatedTransactions: description: | An array of links to request securities transaction details of transactions that resulted from this order. type: array items: $ref: '#/definitions/hrefType' subscription: description: | A link to the resource providing the details of a subscription for Push AIS Services. allOf: - $ref: '#/definitions/hrefType' entryStatusRevoked: description: | Links to entry endpoints where the entry status is revoked. type: array items: $ref: '#/definitions/hrefType' first: description: | Navigation link for paginated account reports. allOf: - $ref: '#/definitions/hrefType' next: description: | Navigation link for paginated account reports. allOf: - $ref: '#/definitions/hrefType' previous: description: | Navigation link for paginated account reports. allOf: - $ref: '#/definitions/hrefType' last: description: | Navigation link for paginated account reports. allOf: - $ref: '#/definitions/hrefType' download: description: | Download link for huge AIS data packages. allOf: - $ref: '#/definitions/hrefType' confirmInitiation: description: | link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. allOf: - $ref: '#/definitions/hrefType' aspspParameters: description: "" allOf: - $ref: '#/definitions/hrefType' aspspContacts: description: "" allOf: - $ref: '#/definitions/hrefType' aspspDowntimes: description: "" allOf: - $ref: '#/definitions/hrefType' onboardings: description: | A link to commercially onboard to the related API, see openFinance, Admin Services for more details. allOf: - $ref: '#/definitions/hrefType' readConditions: description: "" allOf: - $ref: '#/definitions/hrefType' confirmConditions: description: "" allOf: - $ref: '#/definitions/hrefType' partyDescription: description: | See document \"openFinance API Framework Data Dictionary\", section \"Party Description\" for more details. type: object required: - name properties: name: description: | Name of the party. allOf: - $ref: '#/definitions/Max140Text' postaladdress: description: | Postal Address of the party. allOf: - $ref: '#/definitions/postalAddress' identification: description: | Identification of the party. allOf: - $ref: '#/definitions/partyIdentification' additionalPartyInformation: description: "Only supported in extended services for creditor related parties, if at all.\n*NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and \nmight only be used to display related information to the PSU during potential authorisation processes.\n" allOf: - $ref: '#/definitions/additionalPartyInformation' UUID: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string format: uuid example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 genericFinancialInstitutionIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Generic Financial Institution Identification\" for more details. type: object required: - identification properties: identification: description: | Unique and unambiguous identification of a financial insitution. allOf: - $ref: '#/definitions/Max35Text' schemeNameCode: description: | An entry provided by an external ISO code list allOf: - $ref: '#/definitions/FinancialInstitutionIdentificationCode' schemeNameProprietary: description: | A scheme name defined in a proprietary way. allOf: - $ref: '#/definitions/Max35Text' issuer: description: | Issuer of the identification allOf: - $ref: '#/definitions/Max35Text' ClearingSystemIdentificationCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more detail type: string enum: - ATBLZ - AUBSB - CACPA - CHBCC - CHSIC - CNAPS - DEBLZ - ESNCC - GBDSC - GRBIC - HKNCC - IENCC - INFSC - ITNCC - JPZGN - NZNCC - PLKNR - PTNCC - RUCBC - SESBA - SGIBG - THCBC - TWNCC - USABA - USPID - ZANCC - NZRSA - MZBMO - CNCIP - KRBOK example: DEBLZ Max16Text: type: string maxLength: 16 example: 16 Chars at most error_NG_404_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_404_RTP' _links: $ref: '#/definitions/links' postalAddress: description: | See document \"openFinance API Framework Data Dictionary\", section \"Postal Address\" for more details. type: object properties: addressLines: description: | At most seven entries are permitted. May only be used, if none of the structured address elements \"streetName\", \"buildingNumber\", \"postcode\" or \"townName\" is used. *Remark:* For SEPA transactions this is further restricted to a maximum of 1 entry. type: array maxItems: 7 items: $ref: '#/definitions/Max140Text' department: description: | Identification of a division of a large organisation or building. allOf: - $ref: '#/definitions/Max70Text' subDepartment: description: | Identification of a sub-division of a large organisation or building. allOf: - $ref: '#/definitions/Max70Text' streetName: description: | Name of a street or thoroughfare. allOf: - $ref: '#/definitions/Max70Text' buildingNumber: description: | Number that identifies the position of a building on a street. allOf: - $ref: '#/definitions/Max16Text' buildingName: description: | Name of the building or house. allOf: - $ref: '#/definitions/Max35Text' floor: description: | Floor or storey within a building. allOf: - $ref: '#/definitions/Max70Text' postBox: description: | Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. allOf: - $ref: '#/definitions/Max16Text' room: description: | Building room number. allOf: - $ref: '#/definitions/Max70Text' postCode: description: | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. allOf: - $ref: '#/definitions/Max16Text' townName: description: "Name of a built-up area, with defined boundaries, and a local government. \n*Usage Rule:* If address lines are not used, this attribute is mandatrory.\n" allOf: - $ref: '#/definitions/Max35Text' townLocationName: description: | Specific location name within the town. allOf: - $ref: '#/definitions/Max35Text' districtName: description: | Identifies a subdivision within a country sub-division. allOf: - $ref: '#/definitions/Max35Text' countrySubDivision: description: | Identifies a subdivision of a country such as state, region, county. allOf: - $ref: '#/definitions/Max35Text' country: description: | Nation with its own government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. allOf: - $ref: '#/definitions/CountryCode' psuId: description: | Psu Id number or passport number. type: string pattern: ^([0-9]{9}|[A-Za-z]{2}-([A-Za-z0-9]){1,16})$ personIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Person Identification\" for more details. type: object required: - identification properties: identification: description: | Unique and unambiguous identification of a oersib. allOf: - $ref: '#/definitions/psuId' schemeNameCode: description: | An entry provided by an external ISO code list allOf: - $ref: '#/definitions/PersonIdentificationCode' schemeNameProprietary: description: | A scheme name defined in a proprietary way. allOf: - $ref: '#/definitions/Max35Text' issuer: description: | Issuer of the identification allOf: - $ref: '#/definitions/Max35Text' MessageCode_AisSpecific_429: description: | See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details. type: string enum: - ACCESS_EXCEEDED example: ACCESS_EXCEEDED AccountIdentificationCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string enum: - AIIN - BBAN - CUID - UPIC example: AIIN CategoryPurposeCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string enum: - BONU - CASH - CBLK - CCRD - CORT - DCRD - DIVI - DVPM - EPAY - FCIN - FCOL - GP2P - GOVT - HEDG - ICCP - IDCP - INTC - INTE - LBOX - LOAN - MP2B - MP2P - OTHR - PENS - RPRE - RRCT - RVPM - SALA - SECU - SSBE - SUPP - TAXS - TRAD - TREA - VATX - WHLD - SWEP - TOPG - ZABA - VOST - FCDT - CIPC - CONC example: OTHR clearingSystemMemberIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Clearing System Member Identification\" for more details. type: object properties: memberId: description: | Identification of a member of a clearing system. allOf: - $ref: '#/definitions/Max35Text' clearingSystemIdentificationCode: description: | Identification of a clearing system, in a coded form as published in an external list. allOf: - $ref: '#/definitions/ClearingSystemIdentificationCode' clearingSystemIdentificationProprietary: description: | Identification code for a clearing system, that has not yet been identified in the list of clearing systems. allOf: - $ref: '#/definitions/Max35Text' additionalPartyInformation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Additional Party Information\" for more details. type: object properties: tradeName: description: | Trade name of the related party. For display to the PSU only. allOf: - $ref: '#/definitions/Max70Text' merchantCategoryCode: description: | Merchant Category Code as assigned by ISO: allOf: - $ref: '#/definitions/MerchantCategoryCode' logoURL: description: | A hyperlink to the logo of the party. allOf: - $ref: '#/definitions/Max2048Text' geoLocation: description: "" allOf: - $ref: '#/definitions/GeoLocation' agentDescription1: description: | See document \"openFinance API Framework Data Dictionary\", section \"Agent Description1\" for more details. type: object required: - financialInstitutionId properties: financialInstitutionId: description: "" allOf: - $ref: '#/definitions/financialInstitutionIdentification' PurposeCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string enum: - BKDF - BKFE - BKFM - BKIP - BKPP - CBLK - CDCB - CDCD - CDCS - CDDP - CDOC - CDQC - ETUP - FCOL - MTUP - ACCT - CASH - COLL - CSDB - DEPT - INTC - INTP - LIMA - NETT - BFWD - CCIR - CCPC - CCPM - CCSM - CRDS - CRPR - CRSP - CRTL - EQPT - EQUS - EXPT - EXTD - FIXI - FWBC - FWCC - FWSB - FWSC - MARG - MBSB - MBSC - MGCC - MGSC - OCCC - OPBC - OPCC - OPSB - OPSC - OPTN - OTCD - REPO - RPBC - RPCC - RPSB - RPSC - RVPO - SBSC - SCIE - SCIR - SCRP - SHBC - SHCC - SHSL - SLEB - SLOA - SWBC - SWCC - SWPT - SWSB - SWSC - TBAS - TBBC - TBCC - TRCP - AGRT - AREN - BEXP - BOCE - COMC - CPYR - GDDS - GDSV - GSCB - LICF - MP2B - POPE - ROYA - SCVE - SERV - SUBS - SUPP - TRAD - CHAR - COMT - MP2P - ECPG - ECPR - ECPU - EPAY - CLPR - COMP - DBTC - GOVI - HLRP - HLST - INPC - INPR - INSC - INSU - INTE - LBRI - LIFI - LOAN - LOAR - PENO - PPTI - RELG - RINP - TRFD - FORW - FXNT - ADMG - ADVA - BCDM - BCFG - BLDM - BNET - CBFF - CBFR - CCRD - CDBL - CFEE - CGDD - CORT - COST - CPKC - DCRD - DSMT - DVPM - EDUC - FACT - FAND - FCPM - FEES - GIFT - GOVT - ICCP - IDCP - IHRP - INSM - IVPT - MCDM - MCFG - MSVC - NOWS - OCDM - OCFG - OFEE - OTHR - PADD - PTSP - RCKE - RCPT - REBT - REFU - RENT - REOD - RIMB - RPNT - RRBN - RRCT - RRTP - RVPM - SLPI - SPLT - STDY - TBAN - TBIL - TCSC - TELI - TMPG - TPRI - TPRP - TRNC - TRVC - WEBI - IPAY - IPCA - IPDO - IPEA - IPEC - IPEW - IPPS - IPRT - IPU2 - IPUW - ANNI - CAFI - CFDI - CMDT - DERI - DIVD - FREX - HEDG - INVS - PRME - SAVG - SECU - SEPI - TREA - UNIT - FNET - FUTR - ANTS - CVCF - DMEQ - DNTS - HLTC - HLTI - HSPC - ICRF - LTCF - MAFC - MARF - MDCS - VIEW - CDEP - SWFP - SWPP - SWRS - SWUF - ADCS - AEMP - ALLW - ALMY - BBSC - BECH - BENE - BONU - CCHD - COMM - CSLP - GFRP - GVEA - GVEB - GVEC - GVED - GWLT - HREC - PAYR - PEFC - PENS - PRCP - RHBS - SALA - SPSP - SSBE - LBIN - LCOL - LFEE - LMEQ - LMFI - LMRK - LREB - LREV - LSFL - ESTX - FWLV - GSTX - HSTX - INTX - NITX - PTXP - RDTX - TAXS - VATX - WHLD - TAXR - B112 - BR12 - TLRF - TLRR - AIRB - BUSB - FERB - RLWY - TRPT - CBTV - ELEC - ENRG - GASB - NWCH - NWCM - OTLC - PHON - UBIL - WTER - BOND - CABD - CAEQ - CBCR - DBCR - DICL - EQTS - FLCR - EFTC - EFTD - MOMA - RAPI - GAMB - LOTT - AMEX - SASW - AUCO - PCOM - PDEP - PLDS - PLRF - GAFA - GAHO - CPEN - DEPD - RETL - DEBT example: OTHR clientMessageInformation_405_RTP: type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: $ref: '#/definitions/MessageCode_ServiceUnspecific_405' path: type: string text: $ref: '#/definitions/Max500Text' paymentIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Payment Identification\" for more details. type: object properties: instructionId: description: | Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. allOf: - $ref: '#/definitions/Max35Text' endToEndId: description: "" allOf: - $ref: '#/definitions/Max35Text' uetr: description: | Universally unique identifier to provide an end-to-end reference of a payment transaction. It is recommended to use time-based version (version 1) and variant 8,9,a or b of the UUID as defined in [RFC4122] for UUID fields such as uetr. allOf: - $ref: '#/definitions/UUID' ReferredDocumentTypeCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Referred Document Type Code\" for more details. type: string enum: - MSIN - CNFA - DNFA - CINV - CREN - DEBN - HIRI - SBIN - CMCN - SOAC - DISP - BOLD - VCHR - AROI - TSUT - PUOR example: PUOR creditorReferenceInformation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Creditor Reference Information\" for more details. type: object required: - reference properties: reference: description: | The actual reference. allOf: - $ref: '#/definitions/Max35Text' referenceTypeCode: description: | Type of the reference, provided as code. allOf: - $ref: '#/definitions/CreditorReferenceTypeCode' referenceTypeProprietary: description: | Type of the reference, provided in proprietary encoding. allOf: - $ref: '#/definitions/Max35Text' referenceIssuer: description: | Issuer of the reference. allOf: - $ref: '#/definitions/Max35Text' MerchantCategoryCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string maxLength: 4 minLength: 4 CreditorReferenceTypeCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Creditor Reference Type Code\" for more details. type: string enum: - RADM - RPIN - FXDR - DISP - PUOR - SCOR example: PUOR _links_200_RTP: type: object additionalProperties: $ref: '#/definitions/hrefType' properties: scaOAuth: $ref: '#/definitions/hrefType' confirmation: $ref: '#/definitions/hrefType' self: $ref: '#/definitions/hrefType' status: $ref: '#/definitions/hrefType' scaStatus: $ref: '#/definitions/hrefType' CountryCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string pattern: '[A-Z]{2}' example: SE clientMessageInformation: description: | See document \"openFinance API Framework Data Dictionary\", section \"Client Message Information\" for more details. type: object required: - category - code properties: category: description: | Only \"ERROR\" or \"WARNING\" permitted type: string code: [] path: description: | Path of the element of the request message which provoked the error message, if applicable type: string text: description: | Additional explaining text. allOf: - $ref: '#/definitions/Max500Text' Max105Text: type: string maxLength: 105 example: Text, maximum of 105 characters. amount: description: | See document \"openFinance API Framework Data Dictionary\", section \"Amount\" for more details. type: object required: - currency - amount properties: currency: description: | ISO 4217 Alpha 3 currency code allOf: - $ref: '#/definitions/CurrencyCode' amount: description: | The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 type: string pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? error_NG_400_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_400_RTP' _links: $ref: '#/definitions/links' paymentConditions: description: | See document \"openFinance API Framework Data Dictionary\", section \"Payment Conditions\" for more details. type: object properties: amountModificationAllowed: description: | Indicates if the debtor is allowed to pay a different amount then the requested amount. type: boolean earlyPaymentAllowed: description: | Indicates if the debtor is allowed to pay before the requested execution date. type: boolean StatusReasonCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Status Reason Code\" for more details. type: string enum: - AM04 - AM21 - BEXX - CN01 - DS0C - DS0D - DS0A - DS04 - FOCR - SL11 - TKSP - TKXP - AM02 - DT05 - AC05 - AC06 - DS0K - DT01 - UPAY - EOL1 example: AM04 error_NG_409_RTP: type: object properties: apiClientMessages: type: array items: $ref: '#/definitions/clientMessageInformation_409_RTP' _links: $ref: '#/definitions/links' CreditTransferPaymentMethodCode: description: | See document \"openFinance API Framework Data Dictionary\", section \"Credit Transfer Payment Method Code\" for more details. type: string enum: - TRF - CHK example: TRF LEI: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string pattern: '[A-Z0-9]{18,18}[0-9]{2,2}' example: 549300DTUYXVMJXZNY75 MessageCode_AisSpecific_401: description: | See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details. type: string pattern: ^(?!(CONSENT_INVALID|^(?!(CONSENT_INVALID)))) MessageCode_AisSpecific_404: description: | See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details. type: string enum: - CONTENT_TEMPORARILY_NOT_AVAILABLE example: CONTENT_TEMPORARILY_NOT_AVAILABLE MessageCode_AisSpecific_406: description: | See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details. type: string enum: - REQUESTED_FORMATS_INVALID example: REQUESTED_FORMATS_INVALID ISODateTime: description: | See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details. type: string format: date-time example: "2020-01-01T13:00:00.999-01:00" partyIdentification: description: | See document \"openFinance API Framework Data Dictionary\", section \"Party Identification\" for more details. type: object properties: organisationId: description: | An entry provided by an external ISO code list allOf: - $ref: '#/definitions/organisationIdentification' privateId: description: | A scheme name defined in a proprietary way. allOf: - $ref: '#/definitions/privateIdentification' MessageCode_AisSpecific_400: description: | See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details. type: string enum: - CONSENT_TYPE_NOT_SUPPORTED - SESSIONS_NOT_SUPPORTED example: SESSIONS_NOT_SUPPORTED tags: [] externalDocs: description: openFinance API Framework Implementation Guidelines for Extended Services url: https://www.berlin-group.org/openfinance-downloads x-ibm-endpoints: - endpointUrl: https://mtls-api.discountbank.co.il/prod/d type: - production - development ...