Swiss NextGen Banking API-Framework (1.3.4_2019-07-17v1 - Swiss edition 1.3.4.4-CH)
Download OpenAPI specification:Download
The 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 Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely. The NextGen Framework reduces XS2A complexity and costs, addresses the problem of multiple competing standards in Europe and, aligned with the goals of the Euro Retail Payments Board, enables European banking customers to benefit from innovative products and services ('Banking as a Service') by granting TPPs safe and secure (authenticated and authorised) access to their bank accounts and financial data.
The Swiss edtion refines the message formats specific to Switzerland and defines some matching examples.
The possible Approaches are:
Redirect SCA Approach
(Not recommended by obp.ch community) OAuth SCA Approach
(Not recommended by obp.ch community) Decoupled SCA Approach
(Not recommended by obp.ch community) Embedded SCA Approach without SCA method
(Not recommended by obp.ch community) Embedded SCA Approach with only one SCA method available
(Not recommended by obp.ch community) Embedded SCA Approach with Selection of a SCA method
Not every message defined in this API definition is necessary for all approaches. Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional Therefore for a particular implementation of a compliant API it is only necessary to support a certain subset of the methods defined in this API definition.
Please have a look at the implementation guidelines if you are not sure which message has to be used for the approach you are going to use.*
This API definition is based on the Implementation Guidelines of the Berlin Group API. It is not an replacement in any sense. The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group API.
This API definition contains the REST-API for requests from the PISP to the ASPSP.
This API definition contains the messages for all different approaches defined in the Implementation Guidelines.
According to the OpenAPI-Specification [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md]
"If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored."
The element "Accept" will not be defined in this file at any place.
The elements "Content-Type" and "Authorization" are implicitly defined by the OpenApi tags "content" and "security".
There are several predefined types which might occur in payment initiation messages, but are not used in the standard JSON messages in the Implementation Guidelines. Therefore they are not used in the corresponding messages in this file either. We added them for the convenience of the user. If there is a payment product, which need these field, one can easily use the predefined types. But the ASPSP need not to accept them in general.
We omit the definition of all standard HTTP header elements (mandatory/optional/conditional) except they are mention in the Implementation Guidelines. Therefore the implementer might add the in his own realisation of a comlient API in addition to the elements define in this file.
The Berlin Group definition of UTF-8 strings in context of the API have to support at least the following characters
a 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
A 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
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . , ' +
Space
The Decription for Payment Initiation Service (PIS) offers the following services:
- Initiation and update of a payment request
- Status information of a payment
Payment initiation request
This method is used to initiate a payment at the ASPSP.
Variants of Payment Initiation Requests
This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
There are the following payment products:
- Payment products with payment information in JSON format:
- domestic-swiss-credit-transfers-isr
- domestic-swiss-credit-transfers
- domestic-swiss-foreign-credit-transfers
- swiss-sepa-credit-transfers
- swiss-cross-border-credit-transfers
- Payment products with payment information in SIX pain.001 XML format:
- pain.001-sepa-credit-transfers
- pain.001-cross-border-credit-transfers
- pain.001-swiss-six-credit-transfers
Furthermore the request body depends on the payment-service
payments: A single payment initiation request.
bulk-payments: A collection of several payment iniatiation requests.
In case of a pain.001 message there are more than one payments contained in the *pain.001 message.
In case of a JSON there are several JSON payment blocks contained in a joining list.
periodic-payments: Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId} with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.
This is the first step in the API to initiate the related recurring/periodic payment.
Single and mulitilevel SCA Processes
The Payment Initiation Requests are independent from the need of one ore multilevel SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.
But the response messages are specific to either one SCA processing or multilevel SCA processing.
For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation, i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the response message of a Payment Initation Request for a payment, where multiple authorisations are needed. Also if any data is needed for the next action, like selecting an SCA method is not supported in the response, since all starts of the multiple authorisations are fully equal. In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| Consent-ID | string (consentId) This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address required | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Explicit-Authorisation-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. |
| TPP-Rejection-NoFunds-Preferred | string Enum: "true" "false" If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available. If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment. This parameter might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
JSON request body for a payment inition request message
There are the following payment-products supported:
- "domestic-swiss-credit-transfers-isr"
- "domestic-swiss-credit-transfers"
- "domestic-swiss-foreign-credit-transfers"
- "swiss-sepa-credit-transfers" with JSON-Body
- "swiss-cross-border-credit-transfers" with JSON-Body
- "pain.001-sepa-credit-transfers" with XML pain.001.001.03 body for SCT scheme Only country specific schemes are currently available
- "pain.001-cross-border-credit-transfers" with pain.001 body. Only country specific schemes are currently available
- "pain.001-swiss-six-credit-transfers"
There are the following payment-services supported:
- "payments"
- "periodic-payments"
- "bulk-paments"
All optional, conditional and predefined but not yet used fields are defined.
- paymentInitiation_json
- periodicPaymentInitiation_json
- bulkPaymentInitiation_json
| endToEndIdentification | string <= 35 characters |
| debtorAccount required | object (accountReference16-CH) Reference to an account by either
|
| debtorId | string (debtorId) <= 35 characters Debtor Id |
| debtorAgent | object (deptorAgent7-CH) Reference to an deptorAgent by either
|
| debtorName | string (debtorName) <= 70 characters Debtor Name |
| ultimateDebtor | string (ultimateDebtor) <= 70 characters Ultimate Debtor |
| instructedAmount required | object (amount) |
| transactionCurrency | string (currencyCode) [A-Z]{3} ISO 4217 Alpha 3 currency code |
| exchangeRateInformation | object (exchangeRateInformation1) as in ISO pain.001.001.03.ch.02 ExchangeRateInformation1 |
| creditorAccount required | object (accountReference16-CH) Reference to an account by either
|
| creditorAgent | object (creditorAgent7-CH) Reference to an creditorAgent by either
|
| creditorName required | string (creditorName) <= 70 characters Creditor Name |
| creditorId | string (creditorId) <= 35 characters Identification of Creditors, e.g. a SEPA Creditor ID. |
| creditorAddress | object (address) |
| creditorNameAndAddress | string (creditorNameAndAddress) <= 140 characters Creditor Name and Address in a free text field |
| ultimateCreditor | string (ultimateCreditor) <= 70 characters Ultimate Creditor |
| purposeCode | string (purposeCode) Enum: "SALA" "PENS" ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018. |
| serviceLevel | string (externalServiceLevel1Code) <= 4 characters Enum: "SEPA" "PRPT" "SDVA" "URGP" Specifies the external service level code in the format of character string with a maximum length of 4 characters. |
| chargeBearer | string (chargeBearer) Enum: "DEBT" "CRED" "SHAR" "SLEV" Charge Bearer. ChargeBearerType1Code from ISO20022 |
| remittanceInformationUnstructured | string (remittanceInformationUnstructured) <= 140 characters Unstructured remittance information |
| remittanceInformationUnstructuredArray | Array of strings (remittanceInformationUnstructuredArray) Array of unstructured remittance information |
| remittanceInformationStructured | object (remittanceInformationStructured) Structured remittance information |
| requestedExecutionDate | string <date> |
| requestedExecutionTime | string <date-time> |
| intermediaryAgent | string (bicfi) [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} BICFI |
Responses
CREATED
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{- "endToEndIdentification": "54947df80e9e4471a2f99af509fb5889",
- "debtorAccount": {
- "iban": "CH2781412000006944106"
}, - "debtorAgent": {
- "bic": "KBTGCH22XXX"
}, - "debtorName": "Example Isrone",
- "instructedAmount": {
- "currency": "CHF",
- "amount": "1000.00"
}, - "creditorAccount": {
- "otherAccountIdentification": "010391391"
}, - "creditorName": "Kunde 1",
- "creditorAddress": {
- "buildingNumber": "1",
- "townName": "Wittenbach",
- "country": "CH",
- "postCode": "9300",
- "streetName": "Kundenstrasse"
}, - "remittanceInformationStructured": "210000000003139471430009017",
- "requestedExecutionDate": "2019-10-22"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
Response in case of a redirect with an implicitly created authorisation sub-resource
{- "transactionStatus": "RCVD",
- "paymentId": "1234-wertiq-983",
- "_links": {
- "self": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "status": {
- "href": "/v1/payments/1234-wertiq-983/status"
}, - "scaStatus": {
- "href": "/v1/payments/1234-wertiq-983/authorisations/123auth456"
}
}
}Get Payment Information
Returns the content of a payment object
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "endToEndIdentification": "string",
- "debtorAccount": {
- "iban": "FR7612345987650123456789014",
- "otherAccountIdentification": "90-100100-0",
- "currency": "EUR"
}, - "ultimateDebtor": "Ultimate Debtor",
- "instructedAmount": {
- "currency": "EUR",
- "amount": "123"
}, - "creditorAccount": {
- "iban": "FR7612345987650123456789014",
- "otherAccountIdentification": "90-100100-0",
- "currency": "EUR"
}, - "creditorAgent": {
- "bic": "AAAADEBBXXX",
- "iid": {
- "clearingSystemIdCode": "strin",
- "clearingSystemMemberId": "string"
}, - "name": "string",
- "address": {
- "streetName": "string",
- "buildingNumber": "string",
- "townName": "string",
- "postCode": "string",
- "country": "SE",
- "addressLine1": "string",
- "addressLine2": "string"
}
}, - "creditorName": "Creditor Name",
- "creditorAddress": {
- "street": "rue blue",
- "buildingnNumber": "89",
- "city": "Paris",
- "postalCode": "75000",
- "country": "FR"
}, - "ultimateCreditor": "Ultimate Creditor",
- "purposeCode": "SALA",
- "remittanceInformationUnstructured": "Ref Number Merchant",
- "remittanceInformationUnstructuredArray": [
- "Ref Number Merchant",
- "Some Other Text"
], - "remittanceInformationStructured": {
- "reference": "15 00011 23456 78901 23456 78901",
- "referenceType": "string",
- "referenceIssuer": "string"
}, - "requestedExecutionDate": "2021-01-19",
- "requestedExecutionTime": "2021-01-19T07:55:09Z",
- "transactionStatus": "ACCP"
}Payment Cancellation Request
This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message.
Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day).
The response to this DELETE command will tell the TPP whether the
- access method was rejected
- access method was successful, or
- access method is generally applicable, but further authorisation processes are needed.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
Received
No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 202
- 400
- 401
- 403
- 404
- 405
- 409
{- "transactionStatus": "ACTC",
- "_links": {
- "self": {
- "href": "/v1/payments/123456scheduled789"
}, - "status": {
- "href": "/v1/payments/123456scheduled789/status"
}, - "startAuthorisation": {
- "href": "/v1/payments/123456scheduled789/cancellation-authorisations"
}
}
}Payment initiation status request
Check the transaction status of a payment initiation.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "transactionStatus": "ACCP"
}Start the authorisation process for a payment initiation
Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Get Payment Initiation Authorisation Sub-Resources Request
Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "authorisationIds": [
- "123auth456"
]
}Read the SCA Status of the payment authorisation
This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}Update PSU data for payment initiation
This methods updates PSU data on the authorisation resource if needed. It may authorise a payment 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 payment initiation services 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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Start the authorisation process for the cancellation of the addressed payment
Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.
Retrieve a list of all created cancellation authorisation sub-resources.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "cancellationIds": [
- "123auth456"
]
}Read the SCA status of the payment cancellation's authorisation.
This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| cancellationId required | string (cancellationId) Example: 123auth456 Identification for cancellation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}Update PSU Data for payment initiation cancellation
This method updates PSU data on the cancellation authorisation resource if needed. It may authorise a cancellation of the payment 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.
This methods updates PSU data on the cancellation authorisation resource if needed.
There are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services 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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| cancellationId required | string (cancellationId) Example: 123auth456 Identification for cancellation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the ASPSP.
Confirmation of Funds Request
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.
If 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.
Authorizations:
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Authorization | string (authorization) This field might be used in case where a consent was agreed between ASPSP and PSU through an OAuth2 based protocol, facilitated by the TPP. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
Request Body schema: application/json
Request body for a confirmation of funds request.
| cardNumber | string <= 35 characters Card Number of the card issued by the PIISP. Should be delivered if available. |
| account required | object (accountReference16-CH) Reference to an account by either
|
| payee | string <= 70 characters Name payee |
| instructedAmount required | object (amount) |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
Request body for a confirmation of funds.
{- "cardNumber": "12345678901234",
- "account": {
- "iban": "DE23100120020123456789"
}, - "instructedAmount": {
- "currency": "EUR",
- "amount": "123"
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response for a confirmation of funds request.
{- "fundsAvailable": "true"
}The Account Information Service (AIS) offers the following services
- Transaction reports for a given account or card account including balances if applicable.
- Balances of a given account or card account ,
- A list of available accounts or card account ,
- 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
Read Account List
Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.
It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.
Returns all identifiers of the accounts, to which an account access has been granted to through the /consents endpoint by the PSU. In addition, relevant information about the accounts and hyperlinks to corresponding account information resources are provided if a related consent has been already granted.
Remark: Note that the /consents endpoint optionally offers to grant an access on all available payment accounts of a PSU. In this case, this endpoint will deliver the information about all available payment accounts of the PSU at this ASPSP.
Authorizations:
query Parameters
| withBalance | boolean If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID required | string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response in case of an example, where the consent has been given on two different IBANs
{- "accounts": [
- {
- "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
- "iban": "DE2310010010123456789",
- "currency": "EUR",
- "product": "Girokonto",
- "cashAccountType": "CACC",
- "name": "Main Account",
- "_links": {
- "balances": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
}, - "transactions": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
}
}
}, - {
- "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
- "iban": "DE2310010010123456788",
- "currency": "USD",
- "product": "FremdwC$hrungskonto",
- "cashAccountType": "CACC",
- "name": "US Dollar Account",
- "_links": {
- "balances": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
}
}
}
]
}Read Account Details
Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.
NOTE: The account-id can represent a multicurrency account. In this case the currency code is set to "XXX".
Give detailed information about the addressed account.
Give detailed information about the addressed account together with balance information
Authorizations:
path Parameters
| account-id required | string (accountId) Example: qwer3456tzui7890 This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. |
query Parameters
| withBalance | boolean If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID required | string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Account Details for a regular Account
{- "account": {
- "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
- "iban": "FR7612345987650123456789014",
- "currency": "EUR",
- "product": "Girokonto",
- "cashAccountType": "CACC",
- "name": "Main Account",
- "_links": {
- "balances": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
}, - "transactions": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
}
}
}
}Read Balance
Reads account data from a given account addressed by "account-id".
Remark: This account-id can be a tokenised identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This account-id then can be retrieved by the "GET Account List" call.
The account-id is constant at least throughout the lifecycle of a given consent.
Authorizations:
path Parameters
| account-id required | string (accountId) Example: qwer3456tzui7890 This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID required | string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response for a read balance request in case of a regular account.
{- "account": {
- "iban": "FR7612345987650123456789014"
}, - "balances": [
- {
- "balanceType": "closingBooked",
- "balanceAmount": {
- "currency": "EUR",
- "amount": "500.00"
}, - "referenceDate": "2017-10-25"
}, - {
- "balanceType": "expected",
- "balanceAmount": {
- "currency": "EUR",
- "amount": "900.00"
}, - "lastChangeDateTime": "2017-10-25T15:30:35.035Z"
}
]
}Read transaction list of an account
Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.
For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.
Authorizations:
path Parameters
| account-id required | string (accountId) Example: qwer3456tzui7890 This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. |
query Parameters
| dateFrom | string <date> Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. |
| dateTo | string <date> End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. |
| entryReferenceFrom | string This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider. |
| bookingStatus required | string Enum: "booked" "pending" "both" Permitted codes are
|
| deltaList | boolean This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider |
| withBalance | boolean If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID required | string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response in JSON format for an access on a swiss account on aggregation level
{- "account": {
- "iban": "CH2808397020020195606"
}, - "transactions": {
- "booked": [
- {
- "transactionId": "1234573",
- "instructedAmount": {
- "currency": "CHF",
- "amount": "123.50"
}, - "debtorName": "Ricardo Schweiz",
- "debtorAccount": {
- "bban": "01-43884-8"
}, - "remittanceInformationStructured": "15 00011 23456 78901 23456 78901"
}, - {
- "transactionId": "1234571",
- "debtorName": "GlC<ckskette",
- "debtorAccount": {
- "iban": "CH9109000000400018554"
}, - "transactionAmount": {
- "currency": "CHF",
- "amount": "123.45"
}, - "bookingDate": "2019-05-29",
- "valueDate": "2019-05-30",
- "remittanceInformationUnstructured": "FC<r Ferien im Oberland."
}, - {
- "transactionId": "1234572",
- "debtorName": "Stiftung Denk an mich",
- "debtorAccount": {
- "iban": "CH8209000000100150006"
}, - "transactionAmount": {
- "currency": "CHF",
- "amount": "234.55"
}, - "bookingDate": "2019-05-29",
- "valueDate": "2019-05-30",
- "remittanceInformationUnstructured": "FC<r Yemen."
}, - {
- "transactionId": "1234567",
- "creditorName": "John Miles",
- "creditorAccount": {
- "iban": "DE67100100101306118605"
}, - "transactionAmount": {
- "currency": "EUR",
- "amount": "-256.67"
}, - "bookingDate": "2017-10-25",
- "valueDate": "2017-10-26",
- "remittanceInformationUnstructured": "Example 1"
}, - {
- "transactionId": "1234568",
- "debtorName": "Paul Simpson",
- "debtorAccount": {
- "iban": "NL76RABO0359400371"
}, - "transactionAmount": {
- "currency": "EUR",
- "amount": "343.01"
}, - "bookingDate": "2017-10-25",
- "valueDate": "2017-10-26",
- "remittanceInformationUnstructured": "Example 2"
}, - {
- "transactionId": "1234569",
- "debtorName": "Pepe Martin",
- "debtorAccount": {
- "iban": "SE9412309876543211234567"
}, - "transactionAmount": {
- "currency": "USD",
- "amount": "100"
}, - "bookingDate": "2017-10-25",
- "valueDate": "2017-10-26",
- "remittanceInformationUnstructured": "Example 3"
}
], - "pending": [
- {
- "transactionId": "1234570",
- "creditorName": "Claude Renault",
- "creditorAccount": {
- "iban": "FR7612345987650123456789014"
}, - "transactionAmount": {
- "currency": "EUR",
- "amount": "-100.03"
}, - "valueDate": "2017-10-26",
- "remittanceInformationUnstructured": "Example 4"
}
], - "_links": {
- "account": {
- "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f"
}
}
}
}Read Transaction Details
Reads transaction details from a given transaction addressed by "transactionId" on a given account addressed by "account-id". This call is only available on transactions as reported in a JSON format.
Remark: Please note that the PATH might be already given in detail by the corresponding entry of the response of the "Read Transaction List" call within the _links subfield.
Authorizations:
path Parameters
| account-id required | string (accountId) Example: qwer3456tzui7890 This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. |
| transactionId required | string (transactionId) Example: 3dc3d5b3-7023-4848-9853-f5400a64e80f This identification is given by the attribute transactionId of the corresponding entry of a transaction list. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| Consent-ID required | string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Example for transaction details
{- "transactionsDetails": {
- "transactionId": "1234567",
- "creditorName": "John Miles",
- "creditorAccount": {
- "iban": "DE67100100101306118605"
}, - "mandateId": "Mandate-2018-04-20-1234",
- "transactionAmount": {
- "currency": "EUR",
- "amount": "-256.67"
}, - "bookingDate": "2017-10-25",
- "valueDate": "2017-10-26",
- "remittanceInformationUnstructured": "Example 1",
- "bankTransactionCode": "PMNT-RCVD-ESDD"
}
}Create consent
This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method as parameters as a core function.
Side Effects When this Consent Request is a request where the "recurringIndicator" equals "true", and if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU.
Optional Extension: As an option, an ASPSP might optionally accept a specific access right on the access on all related services for all available accounts.
As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. The relation to accounts is then handled afterwards between PSU and ASPSP. This option is not supported for the Embedded SCA Approach. As a last option, an ASPSP might in addition accept a command with access rights
- to see the list of available payment accounts or
- to see the list of available payment accounts with balances.
Authorizations:
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Explicit-Authorisation-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
Requestbody for a consents request
| access required | object (accountAccess) Requested access services for a consent. |
| recurringIndicator required | boolean (recurringIndicator) "true", if the consent is for recurring access to the account data. "false", if the consent is for one access to the account data. |
| validUntil required | string <date> (validUntil) This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30. Future dates might get adjusted by ASPSP. If a maximal available date is requested, a date in far future is to be used: "9999-12-31". In both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date. |
| frequencyPerDay required | integer (frequencyPerDay) >= 1 This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4. |
| combinedServiceIndicator required | boolean If "true" indicates that a payment initiation service will be addressed in the same "session". |
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
Consent request on dedicated accounts
{- "access": {
- "balances": [
- {
- "iban": "DE40100100103307118608"
}, - {
- "iban": "DE02100100109307118603",
- "currency": "USD"
}, - {
- "iban": "DE67100100101306118605"
}
], - "transactions": [
- {
- "iban": "DE40100100103307118608"
}, - {
- "maskedPan": "123456xxxxxx1234"
}
]
}, - "recurringIndicator": "true",
- "validUntil": "2017-11-01",
- "frequencyPerDay": "4"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Consent request Response in case of a redirect
{- "consentStatus": "received",
- "consentId": "1234-wertiq-983",
- "_links": {
- "status": {
- "href": "/v1/consents/1234-wertiq-983/status"
}, - "scaStatus": {
- "href": "v1/consents/1234-wertiq-983/authorisations/123auth567"
}
}
}Get Consent Request
Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Consent request on account list or without indication of accounts
{- "access": {
- "balances": [
- {
- "iban": "DE2310010010123456789"
}
], - "transactions": [
- {
- "iban": "DE2310010010123456789"
}, - {
- "pan": "123456xxxxxx3457"
}
]
}, - "recurringIndicator": "true",
- "validUntil": "2017-11-01",
- "frequencyPerDay": "4",
- "consentStatus": "valid",
- "_links": {
- "account": {
- "href": "/v1/accounts"
}
}
}Delete Consent
The TPP can delete an account information consent object if needed.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "tppMessages": [
- {
- "category": "ERROR",
- "code": "FORMAT_ERROR",
- "path": "string",
- "text": "string"
}
], - "_links": {
- "scaRedirect": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaOAuth": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithAuthenticationMethodSelection": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "selectAuthenticationMethod": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithTransactionAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "authoriseTransaction": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "self": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "status": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaStatus": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "account": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "balances": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactionDetails": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardAccount": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardTransactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "first": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "next": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "previous": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "last": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "download": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property1": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property2": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}
}
}Consent status request
Read the status of an account information consent resource.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response for a consent status request.
{- "consentStatus": "valid"
}Start the authorisation process for a consent
Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.
his method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Get Consent Authorisation Sub-Resources Request
Return a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "authorisationIds": [
- "123auth456"
]
}Read the SCA status of the consent authorisation.
This method returns the SCA status of a consent initiation's authorisation sub-resource.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "scaStatus": "psuAuthenticated"
}Update PSU Data for consents
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.
This methods updates PSU data on the cancellation authorisation resource if needed.
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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Signing basket methods are used for authorising several transactions and resp. or consents with one SCA operation.
Create a signing basket resource
Create a signing basket resource for authorising several transactions with one SCA method. The resource identifications of these transactions are contained in the payload of this access method
Authorizations:
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| Consent-ID | string (consentId) This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. |
| PSU-IP-Address required | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Explicit-Authorisation-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
Request body for a confirmation of an establishing signing basket request
| paymentIds | Array of strings (paymentIdList) non-empty A list of paymentIds |
| consentIds | Array of strings (consentIdList) non-empty A list of consentIds |
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
JSON Body of a signing basket request
{- "paymentIds": [
- "123qwert456789",
- "12345qwert7899"
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
Response (always with explicit authorisation start)
{- "transactionStatus": "RCVD",
- "basketId": "1234-basket-567",
- "_links": {
- "self": {
- "href": "/v1/signing-baskets/1234-basket-567"
}, - "status": {
- "href": "/v1/signing-baskets/1234-basket-567/status"
}, - "startAuthorisation": {
- "href": "/v1/signing-baskets/1234-basket-567/authorisations"
}
}
}Returns the content of an signing basket object.
Returns the content of an signing basket object.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "payments": [
- "1234pay567",
- "1234pay568",
- "1234pay888"
], - "transactionStatus": "ACTC"
}Delete the signing basket
Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.
Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Nevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 400
- 401
- 403
- 404
- 405
- 409
{- "tppMessages": [
- {
- "category": "ERROR",
- "code": "FORMAT_ERROR",
- "path": "string",
- "text": "string"
}
], - "_links": {
- "scaRedirect": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaOAuth": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithAuthenticationMethodSelection": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "selectAuthenticationMethod": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithTransactionAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "authoriseTransaction": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "self": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "status": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaStatus": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "account": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "balances": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactionDetails": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardAccount": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardTransactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "first": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "next": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "previous": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "last": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "download": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property1": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property2": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}
}
}Read the status of the signing basket
Returns the status of a signing basket object.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "transactionStatus": "RCVD"
}Start the authorisation process for a signing basket
Create an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the signing-baskets.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST signing basket call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Get Signing Basket Authorisation Sub-Resources Request
Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "authorisationIds": [
- "123auth456"
]
}Update PSU Data for signing basket
This method update PSU data on the signing basket resource if needed. It may authorise a igning basket 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.
This methods updates PSU data on the cancellation authorisation resource if needed.
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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Read the SCA status of the signing basket authorisation
This method returns the SCA status of a signing basket's authorisation sub-resource.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}Processes on starting authorisations, update PSU identification or PSU authentication data and explicit authorisation of transactions by using SCA are very similar in PIS and AIS and signing baskets services. The API calls supporting these processes are described in the following independently from the service/endpoint. For reasons of clarity, the endpoints are defined always for the Payment Initiation Service, the Payment Cancellation, the Account Information Service (Consents), and Signing Baskets separately. These processes usually are used following a hyperlink of the ASPSP.
Start the authorisation process for a payment initiation
Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the transaction.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Get Payment Initiation Authorisation Sub-Resources Request
Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "authorisationIds": [
- "123auth456"
]
}Read the SCA Status of the payment authorisation
This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}Update PSU data for payment initiation
This methods updates PSU data on the authorisation resource if needed. It may authorise a payment 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 payment initiation services 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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Start the authorisation process for the cancellation of the addressed payment
Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the cancellation-authorisation.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Read the SCA status of the payment cancellation's authorisation.
This method returns the SCA status of a payment initiation's authorisation sub-resource.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| cancellationId required | string (cancellationId) Example: 123auth456 Identification for cancellation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}Update PSU Data for payment initiation cancellation
This method updates PSU data on the cancellation authorisation resource if needed. It may authorise a cancellation of the payment 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.
This methods updates PSU data on the cancellation authorisation resource if needed.
There are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services 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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| payment-service required | string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are:
|
| payment-product required | string Enum: "domestic-swiss-credit-transfers-isr" "domestic-swiss-credit-transfers" "domestic-swiss-foreign-credit-transfers" "swiss-sepa-credit-transfers" "swiss-cross-border-credit-transfers" "pain.001-sepa-credit-transfers" "pain.001-cross-border-credit-transfers" "pain.001-swiss-six-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:
Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants. |
| paymentId required | string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource. |
| cancellationId required | string (cancellationId) Example: 123auth456 Identification for cancellation resource. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Start the authorisation process for a consent
Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.
his method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the consent.
The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Read the SCA status of the consent authorisation.
This method returns the SCA status of a consent initiation's authorisation sub-resource.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
{- "scaStatus": "psuAuthenticated"
}Update PSU Data for consents
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.
This methods updates PSU data on the cancellation authorisation resource if needed.
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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| consentId required | string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 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-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 406
- 409
- 429
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Delete the signing basket
Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.
Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Nevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
No Content
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 400
- 401
- 403
- 404
- 405
- 409
{- "tppMessages": [
- {
- "category": "ERROR",
- "code": "FORMAT_ERROR",
- "path": "string",
- "text": "string"
}
], - "_links": {
- "scaRedirect": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaOAuth": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuIdentification": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateProprietaryData": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updatePsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "updateAdditionalEncryptedPsuAuthentication": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithAuthenticationMethodSelection": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "selectAuthenticationMethod": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "startAuthorisationWithTransactionAuthorisation": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "authoriseTransaction": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "self": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "status": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "scaStatus": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "account": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "balances": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "transactionDetails": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardAccount": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "cardTransactions": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "first": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "next": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "previous": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "last": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "download": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property1": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}, - "property2": {
- "href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}
}
}Read the status of the signing basket
Returns the status of a signing basket object.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "transactionStatus": "RCVD"
}Start the authorisation process for a signing basket
Create an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and authorisation related data.
This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the signing-baskets.
The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST signing basket call.
The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.
This applies in the following scenarios:
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment
Initiation Response that an explicit start of the authorisation process is needed by the TPP.
The 'startAuthorisation' hyperlink can transport more information about data which needs to be
uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
- The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
- The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
- The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
- The signing basket needs to be authorised yet.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| TPP-Redirect-Preferred | string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU. |
| TPP-Redirect-URI | string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification. |
| TPP-Nok-Redirect-URI | string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. |
| TPP-Notification-URI | string URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant. Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply. |
| TPP-Notification-Content-Preferred | string The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP. This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
Created
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
nullResponse samples
- 201
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "received",
- "authorisationId": "123auth456",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Get Signing Basket Authorisation Sub-Resources Request
Read a list of all authorisation subresources IDs which have been created.
This function returns an array of hyperlinks to all generated authorisation sub-resources.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "authorisationIds": [
- "123auth456"
]
}Update PSU Data for signing basket
This method update PSU data on the signing basket resource if needed. It may authorise a igning basket 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.
This methods updates PSU data on the cancellation authorisation resource if needed.
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 need 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 need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-ID | string Example: PSU-1234 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-Type | string 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-ID | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-Corporate-ID-Type | string Might be mandated in the ASPSP's documentation. Only used in a corporate context. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Request Body schema: application/json
- any
- updatePsuAuthentication
- selectPsuAuthenticationMethod
- transactionAuthorisation
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Request samples
- Payload
{ }Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
Response of an Update PSU Identification for a payment initiation request for the decoupled approach.
{- "scatransactionStatus": "psuIdentified",
- "psuMessage": "Please use your BankApp for transaction Authorisation.",
- "_links": {
- "scaStatus": {
- "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}Read the SCA status of the signing basket authorisation
This method returns the SCA status of a signing basket's authorisation sub-resource.
Authorizations:
path Parameters
| basketId required | string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object. |
| authorisationId required | string (authorisationId) Example: 123auth456 Resource identification of the related SCA. |
header Parameters
| X-Request-ID required | string Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party. |
| Digest | string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request. |
| Signature | string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))"
A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
| TPP-Signature-Certificate | string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained. |
| PSU-IP-Address | string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. |
| PSU-IP-Port | string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. |
| PSU-Accept | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Charset | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Encoding | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-Accept-Language | string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. |
| PSU-User-Agent | string The forwarded Agent header field of the HTTP request between PSU and TPP, if available. |
| PSU-Http-Method | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are:
|
| PSU-Device-ID | string Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device. |
| PSU-Geo-Location | string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not found
Method Not Allowed
Not Acceptable
Request Timeout
Conflict
Unsupported Media Type
Too Many Requests
Internal Server Error
Service Unavailable
Open Banking Project Switzerland Developer Portal
Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 409
{- "scaStatus": "psuAuthenticated"
}