openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 400 kB

JSON

{"openapi":"3.0.1","servers":[{"description":"Open Banking Project Switzerland Developer Portal","url":"https://api.dev.openbankingproject.ch"}],"info":{"contact":{"email":"info@obp.ch","name":"Open Banking Project Switzerland","url":"https://www.openbankingproject.ch"},"description":"# Summary\nThe **Swiss NextGen API** is based on the NextGenPSD2 *Framework Version 1.3.4* of the Berlin Group which 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 NextGen 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\nThe Swiss edtion refines the message formats specific to Switzerland and defines some matching examples.\n\nThe possible Approaches are:\n * Redirect SCA Approach\n * *(Not recommended by obp.ch community) OAuth SCA Approach*\n * *(Not recommended by obp.ch community) Decoupled SCA Approach*\n * *(Not recommended by obp.ch community) Embedded SCA Approach without SCA method*\n * *(Not recommended by obp.ch community) Embedded SCA Approach with only one SCA method available*\n * *(Not recommended by obp.ch community) 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 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 API](https://www.berlin-group.org/nextgenpsd2-downloads).**\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 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 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 API have 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/"},"title":"Swiss NextGen Banking API-Framework","version":"1.3.8_2020-12-14 - Swiss edition 1.3.8.1-CH","x-apisguru-categories":["financial"],"x-logo":{"altText":"Swiss OpenBankingProject Logo","backgroundColor":"#FFFFFF","url":"https://openbankingproject-ch.github.io/obp-apis/swiss-ng-logo.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/openbankingproject-ch/obp-apis/master/swiss-ng-api.yaml","version":"3.0"}],"x-providerName":"openbankingproject.ch"},"externalDocs":{"description":"Full Documentation of NextGen Access to Account Interoperability Framework\n(General Introduction Paper, Operational Rules, Implementation Guidelines)\n","url":"https://github.com/openbankingproject-ch/obp-apis"},"security":[{}],"tags":[{"description":"The component for Payment Initiation Service (PIS) offers the following services:\n * Initiation and update of a payment request\n * Status information of a payment\n","name":"Payment Initiation Service (PIS)"},{"description":"Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the ASPSP.\n","name":"Confirmation of Funds Service (PIIS)"},{"description":"The Account Information Service (AIS) offers the following services:\n * Transaction reports for a given account or card account including balances if applicable\n * Balances of a given account or card account\n * A list of available accounts or card account\n * Account details of a given account or card account or of the list of all accessible accounts or card account relative to a granted consent\n","name":"Account Information Service (AIS)"},{"description":"Signing basket methods are used for authorising several transactions and resp. or consents with one SCA operation.\n","name":"Signing Baskets Service (SBS)"},{"description":"Processes on starting authorisations, update PSU identification or PSU authentication data and explicit \nauthorisation of transactions by using SCA are very similar in PIS and AIS and signing baskets services. \nThe API calls supporting these processes are described in the following independently from the service/endpoint. \nFor reasons of clarity, the endpoints are defined always for the Payment Initiation Service, the payment cancellation, \nthe Account Information Service (Consents), and Signing Baskets separately. \nThese processes usually are used following a hyperlink of the ASPSP. \n","name":"Common Services"}],"paths":{"/v1/accounts":{"get":{"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.\nIn addition, relevant information about the accounts and hyperlinks to corresponding account\ninformation resources are provided if a related consent has been already granted.\n\nRemark: Note that the /consents endpoint optionally offers to grant an access on all available\npayment accounts of a PSU.\nIn this case, this endpoint will deliver the information about all available payment accounts\nof the PSU at this ASPSP.\n","operationId":"getAccountList","parameters":[{"$ref":"#/components/parameters/withBalanceQuery"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/consentId_HEADER_mandatory"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$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_AccountList"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read account list","tags":["Account Information Service (AIS)"]}},"/v1/accounts/{account-id}":{"get":{"description":"Reads details about an account, with balances where required. \nIt is assumed that a consent of the PSU to \nthis access is already given and stored on the ASPSP system. \nThe addressed details of this account depends then on the stored consent addressed by consentId, \nrespectively the OAuth2 access token.\n\n**NOTE:** The account-id can represent a multicurrency account.\nIn this case the currency code is set to \"XXX\".\n\nGive detailed information about the addressed account.\n\nGive detailed information about the addressed account together with balance information\n","operationId":"readAccountDetails","parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/withBalanceQuery"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/consentId_HEADER_mandatory"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$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_AccountDetails"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read account details","tags":["Account Information Service (AIS)"]}},"/v1/accounts/{account-id}/balances":{"get":{"description":"Reads account data from a given account addressed by \"account-id\". \n\n**Remark:** This account-id can be a tokenised identification due to data protection reason since the path \ninformation might be logged on intermediary servers within the ASPSP sphere. \nThis account-id then can be retrieved by the \"Get account list\" call.\n\nThe account-id is constant at least throughout the lifecycle of a given consent.\n","operationId":"getBalances","parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/consentId_HEADER_mandatory"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$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_Balances"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read balance","tags":["Account Information Service (AIS)"]}},"/v1/accounts/{account-id}/transactions":{"get":{"description":"Read transaction reports or transaction lists of a given account ddressed by \"account-id\", depending on the steering parameter\n\"bookingStatus\" together with balances.\n\nFor a given account, additional parameters are e.g. the attributes \"dateFrom\" and \"dateTo\".\nThe ASPSP might add balance information, if transaction lists without balances are not supported.\n","operationId":"getTransactionList","parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dateFrom"},{"$ref":"#/components/parameters/dateTo"},{"$ref":"#/components/parameters/entryReferenceFrom"},{"$ref":"#/components/parameters/bookingStatus"},{"$ref":"#/components/parameters/deltaList"},{"$ref":"#/components/parameters/withBalanceQuery"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/consentId_HEADER_mandatory"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$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_AccountsTransactions"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read transaction list of an account","tags":["Account Information Service (AIS)"]}},"/v1/accounts/{account-id}/transactions/{transactionId}":{"get":{"description":"Reads transaction details from a given transaction addressed by \"transactionId\" on a given account addressed by \"account-id\".\nThis call is only available on transactions as reported in a JSON format.\n\n**Remark:** Please note that the PATH might be already given in detail by the corresponding entry of the response of the\n\"Read Transaction List\" call within the _links subfield.\n","operationId":"getTransactionDetails","parameters":[{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/transactionId"},{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"},{"$ref":"#/components/parameters/consentId_HEADER_mandatory"},{"$ref":"#/components/parameters/PSU-IP-Address_conditionalForAis"},{"$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_TransactionDetails"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read transaction details","tags":["Account Information Service (AIS)"]}},"/v1/consents":{"post":{"description":"This method create a consent resource, defining access rights to dedicated accounts of \na given PSU-ID. These accounts are addressed explicitly in the method as \nparameters as a core function.\n\n**Side Effects**\nWhen this consent request is a request where the \"recurringIndicator\" equals \"true\",\nand if it exists already a former consent for recurring access on account information \nfor the addressed PSU, then the former consent automatically expires as soon as the new \nconsent request is authorised by the PSU.\n\nOptional Extension:\nAs an option, an ASPSP might optionally accept a specific access right on the access on all PSD2 related services for all available accounts.\n\nAs another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. \nThe relation to accounts is then handled afterwards between PSU and ASPSP. \nThis option is not supported for the Embedded SCA Approach. \nAs a last option, an ASPSP might in addition accept a command with access rights\n * to see the list of available payment accounts or\n * to see the list of available payment accounts with balances.\n","operationId":"createConsent","parameters":[{"$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-Explicit-Authorisation-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-IP-Address_mandatory"},{"$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/consents"},"responses":{"201":{"$ref":"#/components/responses/CREATED_201_Consents"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Create consent","tags":["Account Information Service (AIS)"]}},"/v1/consents/{consentId}":{"delete":{"description":"The TPP can delete an account information consent object if needed.","operationId":"deleteConsent","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_Consents"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Delete Consent","tags":["Account Information Service (AIS)"]},"get":{"description":"Returns the content of an account information consent object. \nThis is returning the data for the TPP especially in cases, \nwhere the consent was directly managed between ASPSP and PSU e.g. in a redirect SCA Approach.\n","operationId":"getConsentInformation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_ConsentInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Get consent request","tags":["Account Information Service (AIS)"]}},"/v1/consents/{consentId}/authorisations":{"get":{"description":"Return 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":"getConsentAuthorisation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Get consent authorisation sub-resources request","tags":["Account Information Service (AIS)"]},"post":{"description":"Create an authorisation sub-resource and start the authorisation process of a consent.\nThe message might in addition transmit authentication and authorisation related data.\n\nhis 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 consent.\n\nThe ASPSP might make the usage of this access method unnecessary,\nsince the related authorisation resource will be automatically created by\nthe ASPSP after the submission of the consent data with the first POST consents 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 an '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 an '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":"startConsentAuthorisation","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Start the authorisation process for a consent","tags":["Account Information Service (AIS)","Common Services"]}},"/v1/consents/{consentId}/authorisations/{authorisationId}":{"get":{"description":"This method returns the SCA status of a consent initiation's authorisation sub-resource.\n","operationId":"getConsentScaStatus","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Read the SCA status of the consent authorisation","tags":["Account Information Service (AIS)","Common Services"]},"put":{"description":"This method update PSU data on the consents resource if needed.\nIt may authorise a consent 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 a consent request if 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":"updateConsentsPsuData","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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":{"examples":{"Authorisation confirmation (Redirect Approach)":{"$ref":"#/components/examples/authorisationConfirmationExample_Redirect"},"Select PSU authentication method (Embedded Approach)":{"$ref":"#/components/examples/selectPsuAuthenticationMethodExample_Embedded"},"Transaction authorisation (Embedded Approach)":{"$ref":"#/components/examples/transactionAuthorisationExample_Embedded"},"Update PSU authentication (Embedded Approach)":{"$ref":"#/components/examples/updatePsuAuthenticationExample_Embedded"},"Update PSU identification/additional SCA process (Embedded Approach)":{"value":{}}},"schema":{"oneOf":[{},{"$ref":"#/components/schemas/updatePsuAuthentication"},{"$ref":"#/components/schemas/selectPsuAuthenticationMethod"},{"$ref":"#/components/schemas/transactionAuthorisation"},{"$ref":"#/components/schemas/authorisationConfirmation"}]}}}},"responses":{"200":{"$ref":"#/components/responses/OK_200_UpdatePsuData"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Update PSU Data for consents","tags":["Account Information Service (AIS)","Common Services"]}},"/v1/consents/{consentId}/status":{"get":{"description":"Read the status of an account information consent resource.","operationId":"getConsentStatus","parameters":[{"$ref":"#/components/parameters/consentId_PATH"},{"$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_conditionalForAis"},{"$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_ConsentStatus"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_AIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_AIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_AIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_AIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_AIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_AIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_AIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_AIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_AIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_AIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_AIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_AIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Consent status request","tags":["Account Information Service (AIS)"]}},"/v1/funds-confirmations":{"post":{"description":"Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively.\nIf the related extended services are used a conditional Consent-ID is contained in the header. This field is contained but commented out in this specification.","operationId":"checkAvailabilityOfFunds","parameters":[{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Digest"},{"$ref":"#/components/parameters/Signature"},{"$ref":"#/components/parameters/TPP-Signature-Certificate"}],"requestBody":{"$ref":"#/components/requestBodies/confirmationOfFunds"},"responses":{"200":{"$ref":"#/components/responses/OK_200_ConfirmationOfFunds"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_PIIS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_PIIS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_PIIS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_PIIS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_PIIS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_PIIS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_PIIS"},"409":{"$ref":"#/components/responses/CONFLICT_409_PIIS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_PIIS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_PIIS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_PIIS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_PIIS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Confirmation of funds request","tags":["Confirmation of Funds Service (PIIS)"]}},"/v1/signing-baskets":{"post":{"description":"Create a signing basket resource for authorising several transactions with one SCA method. \nThe resource identifications of these transactions are contained in the payload of this access method\n","operationId":"createSigningBasket","parameters":[{"$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-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/signingBasket"},"responses":{"201":{"$ref":"#/components/responses/CREATED_201_SigningBasket"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_SBS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_SBS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_SBS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_SBS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_SBS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_SBS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_SBS"},"409":{"$ref":"#/components/responses/CONFLICT_409_SBS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_SBS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_SBS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_SBS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_SBS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Create a signing basket resource","tags":["Signing Baskets Service (SBS)"]}},"/v1/signing-baskets/{basketId}":{"delete":{"description":"Delete the signing basket structure as long as no (partial) authorisation has yet been applied.\nThe undlerying transactions are not affected by this deletion.\n\nRemark: The signing basket as such is not deletable after a first (partial) authorisation has been applied.\nNevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.\n","operationId":"deleteSigningBasket","parameters":[{"$ref":"#/components/parameters/basketId_PATH"},{"$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":{"204":{"$ref":"#/components/responses/NO_CONTENT_204_SigningBasket"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400_SBS"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401_SBS"},"403":{"$ref":"#/components/responses/FORBIDDEN_403_SBS"},"404":{"$ref":"#/components/responses/NOT_FOUND_404_SBS"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405_SBS"},"406":{"$ref":"#/components/responses/NOT_ACCEPTABLE_406_SBS"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408_SBS"},"409":{"$ref":"#/components/responses/CONFLICT_409_SBS"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415_SBS"},"429":{"$ref":"#/components/responses/TOO_MANY_REQUESTS_429_SBS"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500_SBS"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503_SBS"}},"security":[{},{"BearerAuthOAuth":[]}],"summary":"Delete the signing basket","tags":["Signing Baskets Service (SBS)","Common Services"]},"get":{"description":"Returns the content of a signing basket object.","operationId":"getSigningBasket","parameters":[{"$ref":"#/components/parameters/basketId_PATH"},{"$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":