{ "openapi": "3.0.1", "info": { "title": "NextGenPSD2XS2AFramework", "version": "1.3.6 Jan 31th 2020 - HR Country Specific", "description": "# Summary\nThe **NextGenPSD2** *Framework Version 1.3.6* offers a modern, open, harmonised and interoperable set of\nApplication Programming Interfaces (APIs) as the safest and most efficient way to provide data securely.\nThe NextGenPSD2 Framework reduces XS2A complexity and costs, addresses the problem of multiple competing standards \nin Europe and, aligned with the goals of the Euro Retail Payments Board,\nenables European banking customers to benefit from innovative products and services ('Banking as a Service')\nby granting TPPs safe and secure (authenticated and authorised) access to their bank accounts and financial data.\n\nThis is the Croatian edition of the standard with the changes described in the normative country specific documentation.\n\nThe possible Approaches are:\n * Redirect SCA Approach\n * OAuth SCA Approach\n * Decoupled SCA Approach\n * Embedded SCA Approach without SCA method\n * Embedded SCA Approach with only one SCA method available\n * Embedded SCA Approach with Selection of a SCA method\n\n Not every message defined in this API definition is necessary for all approaches. \n Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional.\n Therefore for a particular implementation of a Berlin Group PSD2 compliant API it is only necessary to support \n a certain subset of the methods defined in this API definition.\n\n **Please have a look at the implementation guidelines if you are not sure \n which message has to be used for the approach you are going to use.**\n\n## Some General Remarks Related to this version of the OpenAPI Specification:\n* **This API definition is based on the Implementation Guidelines of the Berlin Group PSD2 API.** \n It is not a replacement in any sense.\n The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group PSD2 API.\n* **This API definition contains the REST-API for requests from the PISP to the ASPSP.**\n* **This API definition contains the messages for all different approaches defined in the Implementation Guidelines.**\n* According to the OpenAPI-Specification [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md]\n \n \"If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\"\n \n The element \"Accept\" will not be defined in this file at any place.\n \n The elements \"Content-Type\" and \"Authorization\" are implicitly defined by the OpenApi tags \"content\" and \"security\".\n \n* There are several predefined types which might occur in payment initiation messages, \n but are not used in the standard JSON messages in the Implementation Guidelines.\n Therefore they are not used in the corresponding messages in this file either.\n We added them for the convenience of the user.\n If there is a payment product, which needs these fields, one can easily use the predefined types.\n But the ASPSP need not to accept them in general.\n \n* **We omit the definition of all standard HTTP header elements (mandatory/optional/conditional) \n except they are mentioned in the Implementation Guidelines.**\n Therefore the implementer might add these in his own realisation of a PSD2 comlient API in addition to the elements defined in this file.\n \n## General Remarks on Data Types\n\nThe Berlin Group definition of UTF-8 strings in context of the PSD2 API has to support at least the following characters\n\na b c d e f g h i j k l m n o p q r s t u v w x y z\n\nA B C D E F G H I J K L M N O P Q R S T U V W X Y Z\n\n0 1 2 3 4 5 6 7 8 9\n\n/ - ? : ( ) . , ' +\n\nSpace\n", "license": { "name": "Creative Commons Attribution 4.0 International Public License", "url": "https://creativecommons.org/licenses/by/4.0/" }, "contact": { "name": "The Berlin Group - A European Standards Initiative", "url": "https://www.berlin-group.org/", "email": "info@berlin-group.org" } }, "externalDocs": { "description": "Full Documentation of NextGenPSD2 Access to Account Interoperability Framework\n(General Introduction Paper, Operational Rules, Implementation Guidelines)\n", "url": "https://www.berlin-group.org/nextgenpsd2-downloads" }, "servers": [ { "url": "https://api.testbank.com/psd2", "description": "PSD2 server" }, { "url": "https://test-api.testbank.com/psd2", "description": "Optional PSD2 test server" } ], "paths": { "/v1/{payment-service}/{payment-product}": { "post": { "summary": "Payment initiation request", "description": "This method is used to initiate a payment at the ASPSP.\n\n## Variants of payment initiation requests\n\nThis method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.\n\nThere are the following **payment products**:\n\n - Payment products with payment information in *JSON* format:\n - ***sepa-credit-transfers*** (Mandatory Support of ASPSP)\n - ***cross-border-credit-transfers*** (Mandatory Support of ASPSP)\n - ***domestic-credit-transfers-hr*** (Mandatory Support of ASPSP)\n - ***hr-rtgs-payments*** (Optional Support of ASPSP) \n \n - Payment products with payment information in *pain.001* XML format:\n - ***pain.001-credit-transfers***\n\nIt is important to note that the support for *pain.001* XML format is only supported for the bulk payments using the Croatian specific pain.001-credit-transfers!\n\nFurthermore the request body depends on the **payment-service**\n * ***payments***: A single payment initiation request.\n \n In case of single payments, only the *JSON* format is mandatory. The *pain.001* message implementations are ASPSP specific, see individual standard descriptions for your ASPSP.\n * ***bulk-payments***: A collection of several payment iniatiation requests.\n \n In case of a *pain.001* message there are more than one payments contained in the *pain.001* message. \n \n \n## Single and mulitilevel SCA Processes\n\nThe Payment Initiation requests are independent from the need of one or multilevel \nSCA processing, i.e. independent from the number of authorisations needed for the execution of payments. \n\nBut the response messages are specific to either one SCA processing or multilevel SCA processing. \n\nFor payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation, \ni.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the \nresponse message of a Payment Initation Request for a payment, where multiple authorisations are needed. \nAlso if any data is needed for the next action, like selecting an SCA method is not supported in the response, \nsince all starts of the multiple authorisations are fully equal. \nIn these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.\n", "operationId": "initiatePayment", "tags": [ "Payment Initiation Service (PIS)" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-ID" }, { "$ref": "#/components/parameters/PSU-ID-Type" }, { "$ref": "#/components/parameters/PSU-Corporate-ID" }, { "$ref": "#/components/parameters/PSU-Corporate-ID-Type" }, { "$ref": "#/components/parameters/consentId_HEADER_optional" }, { "$ref": "#/components/parameters/PSU-IP-Address_mandatory" }, { "$ref": "#/components/parameters/TPP-Redirect-Preferred" }, { "$ref": "#/components/parameters/TPP-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Nok-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Explicit-Authorisation-Preferred" }, { "$ref": "#/components/parameters/TPP-Rejection-NoFunds-Preferred" }, { "$ref": "#/components/parameters/TPP-Brand-Logging-Information" }, { "$ref": "#/components/parameters/TPP-Notification-URI" }, { "$ref": "#/components/parameters/TPP-Notification-Content-Preferred" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "requestBody": { "$ref": "#/components/requestBodies/paymentInitiation" }, "responses": { "201": { "$ref": "#/components/responses/CREATED_201_PaymentInitiation" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}": { "get": { "summary": "Get payment information", "description": "Returns the content of a payment object", "operationId": "getPaymentInformation", "tags": [ "Payment Initiation Service (PIS)" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_PaymentInitiationInformation" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } }, "delete": { "summary": "Payment cancellation request", "description": "This method initiates the cancellation of a payment. \nDepending on the payment-service, the payment-product and the ASPSP's implementation, \nthis TPP call might be sufficient to cancel a payment. \nIf an authorisation of the payment cancellation is mandated by the ASPSP, \na corresponding hyperlink will be contained in the response message.\n\nCancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day). \n\nThe response to this DELETE command will tell the TPP whether the\n * access method was rejected,\n * access method was successful, or\n * access method is generally applicable, but further authorisation processes are needed.\n", "operationId": "cancelPayment", "tags": [ "Payment Initiation Service (PIS)" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/TPP-Redirect-Preferred" }, { "$ref": "#/components/parameters/TPP-Nok-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Explicit-Authorisation-Preferred" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "204": { "$ref": "#/components/responses/NO_CONTENT_204_PaymentInitiationCancel" }, "202": { "$ref": "#/components/responses/RECEIVED_202_PaymentInitiationCancel" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS_CANC" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}/status": { "get": { "summary": "Payment initiation status request", "description": "Check the transaction status of a payment initiation.", "operationId": "getPaymentInitiationStatus", "tags": [ "Payment Initiation Service (PIS)" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_PaymentInitiationStatus" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}/authorisations": { "post": { "summary": "Start the authorisation process for a payment initiation", "description": "Create an authorisation sub-resource and start the authorisation process. \nThe message might in addition transmit authentication and authorisation related data. \n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the transaction.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n * The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding Payment \n initiation response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n uploaded by using the extended forms:\n * 'startAuthorisationWithPsuIdentfication'\n * 'startAuthorisationWithPsuAuthentication'\n * 'startAuthorisationWithEncryptedPsuAuthentication'\n * 'startAuthorisationWithAuthentciationMethodSelection'\n * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n * The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding \n Payment cancellation response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n by using the extended forms as indicated above.\n * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n executing the cancellation.\n * The signing basket needs to be authorised yet.\n", "operationId": "startPaymentAuthorisation", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/PSU-ID" }, { "$ref": "#/components/parameters/PSU-ID-Type" }, { "$ref": "#/components/parameters/PSU-Corporate-ID" }, { "$ref": "#/components/parameters/PSU-Corporate-ID-Type" }, { "$ref": "#/components/parameters/TPP-Redirect-Preferred" }, { "$ref": "#/components/parameters/TPP-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Nok-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Notification-URI" }, { "$ref": "#/components/parameters/TPP-Notification-Content-Preferred" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ {}, { "$ref": "#/components/schemas/updatePsuAuthentication" }, { "$ref": "#/components/schemas/selectPsuAuthenticationMethod" }, { "$ref": "#/components/schemas/transactionAuthorisation" } ] } } } }, "responses": { "201": { "$ref": "#/components/responses/CREATED_201_StartScaProcess" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } }, "get": { "summary": "Get payment initiation authorisation sub-resources request", "description": "Read a list of all authorisation subresources IDs which have been created.\n\nThis function returns an array of hyperlinks to all generated authorisation sub-resources.\n", "operationId": "getPaymentInitiationAuthorisation", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_Authorisations" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}": { "get": { "summary": "Read the SCA status of the payment authorisation", "description": "This method returns the SCA status of a payment initiation's authorisation sub-resource.\n", "operationId": "getPaymentInitiationScaStatus", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/authorisationId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_ScaStatus" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } }, "put": { "summary": "Update PSU data for payment initiation", "description": "This methods updates PSU data on the authorisation resource if needed. \nIt may authorise a payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThere are several possible update PSU data requests in the context of payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\n A specific update PSU data request is applicable for \n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\n A specific update PSU data request is only applicable for\n * adding the PSU identification, if not provided yet in the payment initiation request or the account information consent request, or if no OAuth2 access token is used, or\n * the selection of authentication methods.\n* Embedded SCA Approach: \n The Update PSU Data request might be used \n * to add credentials as a first factor authentication data of the PSU and\n * to select the authentication method and\n * transaction authorisation.\n\nThe SCA Approach might depend on the chosen SCA method. \nFor that reason, the following possible Update PSU data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n * Update PSU identification\n * Update PSU authentication\n * Select PSU autorization method \n WARNING: This method needs a reduced header, \n therefore many optional elements are not present. \n Maybe in a later version the access path will change.\n * Transaction authorisation\n WARNING: This method needs a reduced header, \n therefore many optional elements are not present. \n Maybe in a later version the access path will change.\n", "operationId": "updatePaymentPsuData", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/authorisationId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-ID" }, { "$ref": "#/components/parameters/PSU-ID-Type" }, { "$ref": "#/components/parameters/PSU-Corporate-ID" }, { "$ref": "#/components/parameters/PSU-Corporate-ID-Type" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ {}, { "$ref": "#/components/schemas/updatePsuAuthentication" }, { "$ref": "#/components/schemas/selectPsuAuthenticationMethod" }, { "$ref": "#/components/schemas/transactionAuthorisation" }, { "$ref": "#/components/schemas/authorisationConfirmation" } ] }, "examples": { "Update PSU identification (Decoupled Approach)": { "value": {} }, "Update PSU authentication (Embedded Approach)": { "$ref": "#/components/examples/updatePsuAuthenticationExample_Embedded" }, "Select PSU authentication method (Embedded Approach)": { "$ref": "#/components/examples/selectPsuAuthenticationMethodExample_Embedded" }, "Transaction authorisation (Embedded Approach)": { "$ref": "#/components/examples/transactionAuthorisationExample_Embedded" }, "Authorisation confirmation (Redirect Approach)": { "$ref": "#/components/examples/authorisationConfirmationExample_Redirect" } } } } }, "responses": { "200": { "$ref": "#/components/responses/OK_200_UpdatePsuData" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations": { "post": { "summary": "Start the authorisation process for the cancellation of the addressed payment", "description": "Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. \nThe message might in addition transmit authentication and authorisation related data.\n\nThis method is iterated n times for a n times SCA authorisation in a \ncorporate context, each creating an own authorisation sub-endpoint for \nthe corresponding PSU authorising the cancellation-authorisation.\n\nThe ASPSP might make the usage of this access method unnecessary in case \nof only one SCA process needed, since the related authorisation resource \nmight be automatically created by the ASPSP after the submission of the \npayment data with the first POST payments/{payment-product} call.\n\nThe start authorisation process is a process which is needed for creating a new authorisation \nor cancellation sub-resource. \n\nThis applies in the following scenarios:\n\n * The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding payment \n initiation response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be \n uploaded by using the extended forms:\n * 'startAuthorisationWithPsuIdentfication'\n * 'startAuthorisationWithPsuAuthentication'\n * 'startAuthorisationWithAuthentciationMethodSelection' \n * The related payment initiation cannot yet be executed since a multilevel SCA is mandated.\n * The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding \n payment cancellation response that an explicit start of the authorisation process is needed by the TPP. \n The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded \n by using the extended forms as indicated above.\n * The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for \n executing the cancellation.\n * The signing basket needs to be authorised yet.\n", "operationId": "startPaymentInitiationCancellationAuthorisation", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-ID" }, { "$ref": "#/components/parameters/PSU-ID-Type" }, { "$ref": "#/components/parameters/PSU-Corporate-ID" }, { "$ref": "#/components/parameters/PSU-Corporate-ID-Type" }, { "$ref": "#/components/parameters/TPP-Redirect-Preferred" }, { "$ref": "#/components/parameters/TPP-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Nok-Redirect-URI" }, { "$ref": "#/components/parameters/TPP-Notification-URI" }, { "$ref": "#/components/parameters/TPP-Notification-Content-Preferred" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ {}, { "$ref": "#/components/schemas/updatePsuAuthentication" }, { "$ref": "#/components/schemas/selectPsuAuthenticationMethod" }, { "$ref": "#/components/schemas/transactionAuthorisation" } ] } } } }, "responses": { "201": { "$ref": "#/components/responses/CREATED_201_StartScaProcess" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } }, "get": { "summary": "Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources", "description": "Retrieve a list of all created cancellation authorisation sub-resources.\n", "operationId": "getPaymentInitiationCancellationAuthorisationInformation", "tags": [ "Payment Initiation Service (PIS)" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_CancellationList" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}": { "get": { "summary": "Read the SCA status of the payment cancellation's authorisation", "description": "This method returns the SCA status of a payment initiation's authorisation sub-resource.\n", "operationId": "getPaymentCancellationScaStatus", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/cancellationId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "$ref": "#/components/responses/OK_200_ScaStatus" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } }, "put": { "summary": "Update PSU data for payment initiation cancellation", "description": "This method updates PSU data on the cancellation authorisation resource if needed. \nIt may authorise a cancellation of the payment within the Embedded SCA Approach where needed.\n\nIndependently from the SCA Approach it supports e.g. the selection of \nthe authentication method and a non-SCA PSU authentication.\n\nThis methods updates PSU data on the cancellation authorisation resource if needed. \n\nThere are several possible update PSU data requests in the context of a cancellation authorisation within the payment initiation services needed, \nwhich depends on the SCA approach:\n\n* Redirect SCA Approach:\n A specific Update PSU data request is applicable for \n * the selection of authentication methods, before choosing the actual SCA approach.\n* Decoupled SCA Approach:\n A specific Update PSU data request is only applicable for\n * adding the PSU Identification, if not provided yet in the payment initiation request or the Account Information Consent Request, or if no OAuth2 access token is used, or\n * the selection of authentication methods.\n* Embedded SCA Approach: \n The Update PSU data request might be used \n * to add credentials as a first factor authentication data of the PSU and\n * to select the authentication method and\n * transaction authorisation.\n\nThe SCA approach might depend on the chosen SCA method. \nFor that reason, the following possible update PSU data request can apply to all SCA approaches:\n\n* Select an SCA method in case of several SCA methods are available for the customer.\n\nThere are the following request types on this access path:\n * Update PSU identification\n * Update PSU authentication\n * Select PSU autorization method \n WARNING: This method needs a reduced header, \n therefore many optional elements are not present. \n Maybe in a later version the access path will change.\n * Transaction Authorisation\n WARNING: This method needs a reduced header, \n therefore many optional elements are not present. \n Maybe in a later version the access path will change.\n", "operationId": "updatePaymentCancellationPsuData", "tags": [ "Payment Initiation Service (PIS)", "Common Services" ], "security": [ {}, { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/paymentService" }, { "$ref": "#/components/parameters/paymentProduct" }, { "$ref": "#/components/parameters/paymentId" }, { "$ref": "#/components/parameters/cancellationId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/TPP-Signature-Certificate" }, { "$ref": "#/components/parameters/PSU-ID" }, { "$ref": "#/components/parameters/PSU-ID-Type" }, { "$ref": "#/components/parameters/PSU-Corporate-ID" }, { "$ref": "#/components/parameters/PSU-Corporate-ID-Type" }, { "$ref": "#/components/parameters/PSU-IP-Address_optional" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Accept" }, { "$ref": "#/components/parameters/PSU-Accept-Charset" }, { "$ref": "#/components/parameters/PSU-Accept-Encoding" }, { "$ref": "#/components/parameters/PSU-Accept-Language" }, { "$ref": "#/components/parameters/PSU-User-Agent" }, { "$ref": "#/components/parameters/PSU-Http-Method" }, { "$ref": "#/components/parameters/PSU-Device-ID" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ {}, { "$ref": "#/components/schemas/updatePsuAuthentication" }, { "$ref": "#/components/schemas/selectPsuAuthenticationMethod" }, { "$ref": "#/components/schemas/transactionAuthorisation" }, { "$ref": "#/components/schemas/authorisationConfirmation" } ] }, "examples": { "Update PSU Identification (Embedded Approach)": { "value": {} }, "Update PSU authentication (Embedded Approach)": { "$ref": "#/components/examples/updatePsuAuthenticationExample_Embedded" }, "Select PSU Authentication Method (Embedded Approach)": { "$ref": "#/components/examples/selectPsuAuthenticationMethodExample_Embedded" }, "Transaction Authorisation (Embedded Approach)": { "$ref": "#/components/examples/transactionAuthorisationExample_Embedded" }, "Authorisation confirmation (Redirect Approach)": { "$ref": "#/components/examples/authorisationConfirmationExample_Redirect" } } } } }, "responses": { "200": { "$ref": "#/components/responses/OK_200_UpdatePsuData" }, "400": { "$ref": "#/components/responses/BAD_REQUEST_400_PIS" }, "401": { "$ref": "#/components/responses/UNAUTHORIZED_401_PIS" }, "403": { "$ref": "#/components/responses/FORBIDDEN_403_PIS" }, "404": { "$ref": "#/components/responses/NOT_FOUND_404_PIS" }, "405": { "$ref": "#/components/responses/METHOD_NOT_ALLOWED_405_PIS" }, "406": { "$ref": "#/components/responses/NOT_ACCEPTABLE_406_PIS" }, "408": { "$ref": "#/components/responses/REQUEST_TIMEOUT_408_PIS" }, "409": { "$ref": "#/components/responses/CONFLICT_409_PIS" }, "415": { "$ref": "#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIS" }, "429": { "$ref": "#/components/responses/TOO_MANY_REQUESTS_429_PIS" }, "500": { "$ref": "#/components/responses/INTERNAL_SERVER_ERROR_500_PIS" }, "503": { "$ref": "#/components/responses/SERVICE_UNAVAILABLE_503_PIS" } } } }, "/v1/accounts": { "get": { "summary": "Read account list", "description": "Read the identifiers of the available payment account together with \nbooking balance information, depending on the consent granted.\n\nIt is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. \nThe addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, \nrespectively the OAuth2 access token. \n\nReturns all identifiers of the accounts, to which an account access has been granted to through \nthe /consents endpoint by the PSU. \n" } } } }