Account Information Service (AIS)

Common Services

Update PSU Data for consents

Changed on Mar 9, 2021

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.

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
- none
- or HTTP bearer

Path parameters

consentIdstring required

ID of the corresponding consent object as returned by an account information consent request.

authorisationIdstring required

Resource identification of the related SCA.

Example:123auth456

Headers

X-Request-IDstring required

ID of the request, unique to the call, as determined by the initiating party.

Digeststring

Is contained if and only if the "Signature" element is contained in the header of the request.

Signaturestring

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificatestring byte

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IDstring

Client ID of the PSU in the ASPSP client interface.

Might be mandated in the ASPSP's documentation.

It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.

PSU-ID-Typestring

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP's documentation.

PSU-Corporate-IDstring

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Typestring

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-IP-Addressstring ipv4

The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

PSU-IP-Portstring

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Acceptstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Charsetstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Encodingstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Languagestring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-User-Agentstring

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

GET
POST
PUT
PATCH
DELETE

PSU-Device-IDstring

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.

PSU-Geo-Locationstring

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request body

unknown required

Example request

{
  "authenticationMethodId": "myAuthenticationID"
}

Response

Example response

{
  "transactionFees": {
    "currency": "EUR",
    "amount": "123"
  },
  "currencyConversionFees": {
    "currency": "EUR",
    "amount": "123"
  },
  "estimatedTotalAmount": {
    "currency": "EUR",
    "amount": "123"
  },
  "estimatedInterbankSettlementAmount": {
    "currency": "EUR",
    "amount": "123"
  },
  "scaMethods": [
    {
      "authenticationMethodId": "myAuthenticationID",
      "name": "SMS OTP on phone +49160 xxxxx 28",
      "explanation": "Detailed information about the SCA method for the PSU."
    }
  ],
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
    },
    "selectAuthenticationMethod": {
      "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "scaStatus": "psuAuthenticated"
}

Changes

Mar 9, 20210d82c4699548 Revision changes
- breaking
  added to the response body oneOf list for the response status
- warning
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)
- warning
  added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)
- warning
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)
- warning
  added the new SMTP_OTP enum value to the ////// response property for the response status
- warning
  added the new SMTP_OTP enum value to the ////// response property for the response status
- warning
  added the new unconfirmed enum value to the //// response property for the response status
- warning
  added the new unconfirmed enum value to the //// response property for the response status
- warning
  added the new unconfirmed enum value to the //// response property for the response status
- warning
  added the new unconfirmed enum value to the //// response property for the response status
- info
  added to the request body oneOf list
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property / to the response with the status (media type: application/json)
- info
  added the optional property / to the response with the status (media type: application/problem+json)
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  the response property //// became required for the status
Mar 9, 2021b51fe6ddb1fc Revision changes
- breaking
  removed from the request body oneOf list
- breaking
  the response property //// became optional for the status
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
- breaking
  the //// response property's maxLength was increased from 500 to 512 for the response status
- breaking
  the //// response property's maxLength was increased from 500 to 512 for the response status
- breaking
  the //// response property's maxLength was increased from 500 to 512 for the response status
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
- breaking
  the ///// response's property format changed from url to no format for status
- breaking
  the ///// response's property format changed from url to no format for status
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property / from the response with the status (media type: application/json)
- warning
  removed the optional property / from the response with the status (media type: application/problem+json)
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- warning
  removed the optional property //// from the response with the status
- info
  for the header request parameter PSU-Device-ID, the format was generalized from uuid to no format
- info
  for the header request parameter X-Request-ID, the format was generalized from uuid to no format
- info
  removed from the response body oneOf list for the response status
- info
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/problem+json)
- info
  removed the SCA_INVALID enum value from the response property for the response status (media type: application/problem+json)
- info
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/json)
- info
  removed the SMTP_OTP enum value from the ////// response property for the response status
- info
  removed the SMTP_OTP enum value from the ////// response property for the response status
- info
  removed the unconfirmed enum value from the //// response property for the response status
- info
  removed the unconfirmed enum value from the //// response property for the response status
- info
  removed the unconfirmed enum value from the //// response property for the response status
- info
  removed the unconfirmed enum value from the //// response property for the response status

Operation history (5 revisions)

Update PSU Data for consents

Request

Path parameters

Headers

Request body

Example request

Response 200OK

Example response

Changes

Response