--- title: "Update PSU Data for consents" method: PUT path: "/v1/consents/{consentId}/authorisations/{authorisationId}" tags: ["Account Information Service (AIS)", "Common Services"] --- # Update PSU Data for consents `PUT /v1/consents/{consentId}/authorisations/{authorisationId}` ## Request - Base URL: `https://api.dev.openbankingproject.ch` - URL: `https://api.dev.openbankingproject.ch/v1/consents/{consentId}/authorisations/{authorisationId}` - Auth: one of: - none - HTTP bearer This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed. Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication. There are several possible update PSU data requests in the context of a consent request if needed, which depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU data request is applicable for * the selection of authentication methods, before choosing the actual SCA approach. * Decoupled SCA Approach: A specific update PSU data request is only applicable for * 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 * the selection of authentication methods. * Embedded SCA Approach: The Update PSU data request might be used * to add credentials as a first factor authentication data of the PSU and * to select the authentication method and * transaction authorisation. The SCA Approach might depend on the chosen SCA method. For that reason, the following possible update PSU data request can apply to all SCA approaches: * Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: * Update PSU identification * Update PSU authentication * Select PSU autorization method WARNING: This method needs a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change. * Transaction Authorisation WARNING: This method needs a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change. ## Path parameters - `consentId` string, required: ID of the corresponding consent object as returned by an account information consent request. - `authorisationId` string, required: Resource identification of the related SCA. ## Headers - `X-Request-ID` string, required - `Digest` string - `Signature` string - `TPP-Signature-Certificate` string, byte - `PSU-ID` string - `PSU-ID-Type` string - `PSU-Corporate-ID` string - `PSU-Corporate-ID-Type` string - `PSU-IP-Address` string, ipv4 - `PSU-IP-Port` string - `PSU-Accept` string - `PSU-Accept-Charset` string - `PSU-Accept-Encoding` string - `PSU-Accept-Language` string - `PSU-User-Agent` string - `PSU-Http-Method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' - `PSU-Device-ID` string - `PSU-Geo-Location` string ## Request body - union - unknown - UpdatePsuAuthentication: Content of the body of a Update PSU authentication request Password subfield is used. - `psuData` PsuData, required: PSU Data for Update PSU authentication. - `password` string: Password. - `encryptedPassword` string: Encrypted password. - `additionalPassword` string: Additional password in plaintext. - `additionalEncryptedPassword` string: Additional encrypted password. - SelectPsuAuthenticationMethod: Content of the body of a Select PSU authentication method request - `authenticationMethodId` string, required: An identification provided by the ASPSP for the later identification of the authentication method selection. - TransactionAuthorisation: Content of the body of a transaction authorisation request - `scaAuthenticationData` string, required: SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded. - AuthorisationConfirmation: Content of the body of an authorisation confirmation request - `confirmationCode` string, required: Confirmation Code as retrieved by the TPP from the redirect based SCA process. ## Response `200` OK - union - UpdatePsuIdenticationResponse: Body of the JSON response for a successful update PSU identification request. - `transactionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `currencyConversionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedTotalAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedInterbankSettlementAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `scaMethods` AuthenticationObject[]: This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body. These methods shall be presented towards the PSU for selection by the TPP. - `authenticationType` 'SMS_OTP' | 'CHIP_OTP' | 'PHOTO_OTP' | 'PUSH_OTP' | 'SMTP_OTP', required: Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. - 'SMTP_OTP': An OTP is sent via email to the PSU. - `authenticationVersion` string: Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation. - `authenticationMethodId` string, required: An identification provided by the ASPSP for the later identification of the authentication method selection. - `name` string: This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. - `explanation` string: Detailed information about the SCA method for the PSU. - `_links` LinksUpdatePsuIdentification, required: A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. **Remark:** All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions): - 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. - 'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there are several available authentication methods and if the PSU is already sufficiently authenticated.. If this link is contained, then there is also the data element "scaMethods" contained in the response body. - `scaStatus` HrefType: Link to a resource. - `href` string: Link to a resource. - `selectAuthenticationMethod` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaStatus` 'received' | 'psuIdentified' | 'psuAuthenticated' | 'scaMethodSelected' | 'started' | 'unconfirmed' | 'finalised' | 'failed' | 'exempted', required: This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. * 'received': An authorisation or cancellation-authorisation resource has been created successfully. * 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified. * 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token. * 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'. * 'unconfirmed': SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. * 'started': The addressed SCA routine has been started. * 'finalised': The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource. * 'failed': The SCA routine failed. This is a final status of the authorisation resource. * 'exempted': SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource. - `psuMessage` string: Text to be displayed to the PSU. - UpdatePsuAuthenticationResponse: Body of the JSON response for a successful update PSU authentication request. - `transactionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `currencyConversionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedTotalAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedInterbankSettlementAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `chosenScaMethod` ChosenScaMethod: Authentication object. - `authenticationType` 'SMS_OTP' | 'CHIP_OTP' | 'PHOTO_OTP' | 'PUSH_OTP' | 'SMTP_OTP', required: Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. - 'SMTP_OTP': An OTP is sent via email to the PSU. - `authenticationVersion` string: Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation. - `authenticationMethodId` string, required: An identification provided by the ASPSP for the later identification of the authentication method selection. - `name` string: This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. - `explanation` string: Detailed information about the SCA method for the PSU. - `challengeData` ChallengeData: It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link. - `image` string, byte: PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method. - `data` string[]: A collection of strings as challenge data. - `imageLink` string: A link where the ASPSP will provides the challenge image for the TPP. - `otpMaxLength` integer: The maximal length for the OTP to be typed in by the PSU. - `otpFormat` 'characters' | 'integer': The format type of the OTP to be typed in. The admitted values are "characters" or "integer". - `additionalInformation` string: Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU. - `scaMethods` AuthenticationObject[]: This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body. These methods shall be presented towards the PSU for selection by the TPP. - `authenticationType` 'SMS_OTP' | 'CHIP_OTP' | 'PHOTO_OTP' | 'PUSH_OTP' | 'SMTP_OTP', required: Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. - 'SMTP_OTP': An OTP is sent via email to the PSU. - `authenticationVersion` string: Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation. - `authenticationMethodId` string, required: An identification provided by the ASPSP for the later identification of the authentication method selection. - `name` string: This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. - `explanation` string: Detailed information about the SCA method for the PSU. - `_links` LinksUpdatePsuAuthentication: A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU. Type of links admitted in this response: * 'updateAdditionalPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional PSU password. This link is only contained in rare cases, where such additional passwords are needed for PSU authentications. * 'updateAdditionalEncryptedPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional encrypted PSU password. This link is only contained in rare cases, where such additional passwords are needed for PSU authentications. * 'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. This link is only contained, if the PSU is already identified or authenticated with the first relevant factor or alternatively an access token, if SCA is required and if the PSU has a choice between different authentication methods. If this link is contained, then there is also the data element 'scaMethods' contained in the response body. * 'authoriseTransaction': The link to the resource, where the "Transaction authorisation request" is sent to. This is the link to the resource which will authorise the transaction by checking the SCA authentication data within the Embedded SCA approach. * 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. - `updateAdditionalPsuAuthentication` HrefType: Link to a resource. - `href` string: Link to a resource. - `updateAdditionalEncryptedPsuAuthentication` HrefType: Link to a resource. - `href` string: Link to a resource. - `selectAuthenticationMethod` HrefType: Link to a resource. - `href` string: Link to a resource. - `authoriseTransaction` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaStatus` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaStatus` 'received' | 'psuIdentified' | 'psuAuthenticated' | 'scaMethodSelected' | 'started' | 'unconfirmed' | 'finalised' | 'failed' | 'exempted', required: This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. * 'received': An authorisation or cancellation-authorisation resource has been created successfully. * 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified. * 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token. * 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'. * 'unconfirmed': SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. * 'started': The addressed SCA routine has been started. * 'finalised': The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource. * 'failed': The SCA routine failed. This is a final status of the authorisation resource. * 'exempted': SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource. - `psuMessage` string: Text to be displayed to the PSU. - `authorisationId` string: Resource identification of the related SCA. - SelectPsuAuthenticationMethodResponse: Body of the JSON response for a successful select PSU authentication method request. - `transactionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `currencyConversionFees` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedTotalAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `estimatedInterbankSettlementAmount` Amount - `currency` string, required: ISO 4217 Alpha 3 currency code. - `amount` string, required: The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 - `chosenScaMethod` ChosenScaMethod: Authentication object. - `authenticationType` 'SMS_OTP' | 'CHIP_OTP' | 'PHOTO_OTP' | 'PUSH_OTP' | 'SMTP_OTP', required: Type of the authentication method. More authentication types might be added during implementation projects and documented in the ASPSP documentation. - 'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel. - 'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. a TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU. - 'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU. - 'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU. - 'SMTP_OTP': An OTP is sent via email to the PSU. - `authenticationVersion` string: Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation. - `authenticationMethodId` string, required: An identification provided by the ASPSP for the later identification of the authentication method selection. - `name` string: This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available. - `explanation` string: Detailed information about the SCA method for the PSU. - `challengeData` ChallengeData: It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link. - `image` string, byte: PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method. - `data` string[]: A collection of strings as challenge data. - `imageLink` string: A link where the ASPSP will provides the challenge image for the TPP. - `otpMaxLength` integer: The maximal length for the OTP to be typed in by the PSU. - `otpFormat` 'characters' | 'integer': The format type of the OTP to be typed in. The admitted values are "characters" or "integer". - `additionalInformation` string: Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU. - `_links` LinksSelectPsuAuthenticationMethod: A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. **Remark:** All links can be relative or full links, to be decided by the ASPSP. **Remark:** This method can be applied before or after PSU identification. This leads to many possible hyperlink responses. Type of links admitted in this response, (further links might be added for ASPSP defined extensions): - 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser. - 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification. * 'confirmation': Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated OAuth based authentication process with the ASPSP authentication server. - 'updatePsuIdentification': The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded. - 'updatePsuAuthentication': The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded. - 'updateEncryptedPsuAuthentication': The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication encrypted data needs to be uploaded. - 'updateAdditionalPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional PSU password. - 'updateAdditionalEncryptedPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional encrypted PSU password. - 'authoriseTransaction': The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS. - 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. - `scaRedirect` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaOAuth` HrefType: Link to a resource. - `href` string: Link to a resource. - `confirmation` HrefType: Link to a resource. - `href` string: Link to a resource. - `updatePsuIdentification` HrefType: Link to a resource. - `href` string: Link to a resource. - `updatePsuAuthentication` HrefType: Link to a resource. - `href` string: Link to a resource. - `updateAdditionalPsuAuthentication` HrefType: Link to a resource. - `href` string: Link to a resource. - `updateAdditionalEncryptedPsuAuthentication` HrefType: Link to a resource. - `href` string: Link to a resource. - `authoriseTransaction` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaStatus` HrefType: Link to a resource. - `href` string: Link to a resource. - `scaStatus` 'received' | 'psuIdentified' | 'psuAuthenticated' | 'scaMethodSelected' | 'started' | 'unconfirmed' | 'finalised' | 'failed' | 'exempted', required: This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. * 'received': An authorisation or cancellation-authorisation resource has been created successfully. * 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified. * 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token. * 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'. * 'unconfirmed': SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. * 'started': The addressed SCA routine has been started. * 'finalised': The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource. * 'failed': The SCA routine failed. This is a final status of the authorisation resource. * 'exempted': SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource. - `psuMessage` string: Text to be displayed to the PSU. - ScaStatusResponse: Body of the JSON response with SCA Status. - `scaStatus` 'received' | 'psuIdentified' | 'psuAuthenticated' | 'scaMethodSelected' | 'started' | 'unconfirmed' | 'finalised' | 'failed' | 'exempted', required: This data element is containing information about the status of the SCA method applied. The following codes are defined for this data type. * 'received': An authorisation or cancellation-authorisation resource has been created successfully. * 'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified. * 'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token. * 'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'. * 'unconfirmed': SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. * 'started': The addressed SCA routine has been started. * 'finalised': The SCA routine has been finalised successfully (including a potential confirmation command). This is a final status of the authorisation resource. * 'failed': The SCA routine failed. This is a final status of the authorisation resource. * 'exempted': SCA was exempted for the related transaction, the related authorisation is successful. This is a final status of the authorisation resource. - `psuMessage` string: Text to be displayed to the PSU. - `trustedBeneficiaryFlag` boolean: Additional Service: Trusted Benificiaries Within this data element, the ASPSP might optionally communicate towards the TPP whether the creditor was part of the related trusted beneficiary list. This attribute is only contained in case of a final scaStatus. - AuthorisationConfirmationResponse: Body of the JSON response for an authorisation confirmation request. - `scaStatus` 'finalised' | 'failed', required: This data element is containing information about the status of the SCA method in an authorisation confirmation response. The following codes are defined for this data type. * 'finalised': if the transaction authorisation and confirmation was successfule. * 'failed': if the transaction authorisation or confirmation was not successful. - `_links` LinksAuthorisationConfirmation, required: A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. **Remark:** All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions): - 'scaStatus': The link to retrieve the status of the corresponding transaction resource. - `scaStatus` HrefType: Link to a resource. - `href` string: Link to a resource. - `psuMessage` string: Text to be displayed to the PSU. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not found - `405`: Method Not Allowed - `406`: Not Acceptable - `408`: Request Timeout - `409`: Conflict - `415`: Unsupported Media Type - `429`: Too Many Requests - `500`: Internal Server Error - `503`: Service Unavailable ## Changes > 70 revisions in range; 2 not diffed. - **2021-03-09** `0d82c4699548`: 1 breaking, 9 warning, 34 info - added `#/components/schemas/authorisationConfirmationResponse` to the response body `oneOf` list for the response status `200` - added the new `SCA_INVALID` enum value to the `additionalErrors/items/code` response property for the response status `400` (media type: application/problem+json) - added the new `SCA_INVALID` enum value to the `code` response property for the response status `400` (media type: application/problem+json) - added the new `SCA_INVALID` enum value to the `tppMessages/items/code` response property for the response status `400` (media type: application/json) - …40 more - **2021-03-09** `b51fe6ddb1fc`: 31 breaking, 32 warning, 12 info - removed `#/components/schemas/authorisationConfirmation` from the request body `oneOf` list - the response property `oneOf[#/components/schemas/scaStatusResponse]/scaStatus` became optional for the status `200` - the `additionalErrors/items/detail` response property's maxLength was increased from `500` to `512` for the response status `400` (media type: application/problem+json) - the `additionalErrors/items/detail` response property's maxLength was increased from `500` to `512` for the response status `401` (media type: application/problem+json) - …71 more - …earlier changes not shown [Operation history](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/changes/v1/consents/:consentId/authorisations/:authorisationId/put.md) --- [API](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework.md) - [All operations](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/llms.txt) - [OpenAPI document](https://skmtc.dev/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/revisions/c32e86db40b4?raw)