1.0.57

NextGenPSD2 XS2A Framework
API docs by Redocly

NextGenPSD2 XS2A Framework (1.3.3)

Download OpenAPI specification:Download

Open Payments Europe AB: info@openpayments.io URL: https://www.openpayments.io/ License: Creative Commons Attribution 4.0 International Public License
Full Documentation of NextGenPSD2 Access to Account Interoperability Framework (General Introduction Paper, Operational Rules, Implementation Guidelines)

Summary

Open Payments Europe NextGenPSD2 API definition is based on The Berlin Group NextGenPSD2 Framework with some additional services like the ASPSP Information Services. The NextGenPSD2 Framework Version 1.3.3 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 NextGenPSD2 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 possible Approaches are:

  • Redirect SCA Approach
  • OAuth SCA Approach
  • Decoupled SCA Approach
  • Embedded SCA Approach without SCA method
  • Embedded SCA Approach with only one SCA method available
  • 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

General Remarks on Data Types

The Berlin Group definition of UTF-8 strings in context of the PSD2 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

/ - ? : ( ) . , ' +

ASPSP Information Service (ASPSPIS)

The ASPSP Information Services (ASPSPIS) offers the following services:

  • All ASPSPs in a specific city or country
  • List all ASPSPs connected to the Open Banking Platform.
  • Details about the ASPSP
  • To access the ASPSP Information Services use the aspspinformation scope.

Get ASPSP List

Gets all ASPSPs currently supported in the Open Banking Platform.

Authorizations:
oAuth2oAuth2
query Parameters
isoCountryCodes
Array of strings (isoCountryCodes)
Example: isoCountryCodes=SE,FI

ISO Country Codes for the countries to get ASPSPs for

cityIds
Array of strings <uuid> (cityIds)
Example: cityIds=37efa883-c8ad-4ff7-927b-b11b02beb923,ba9dd929-1408-33a6-3ce2-bc45fcfaaa5c

City IDs for the countries to get ASPSPs for

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{}

Get ASPSP Details

Gets details about an ASPSP by BICFI.

Authorizations:
oAuth2oAuth2
path Parameters
bicFi
required
string^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...
Example: OPBKSE21

The BICFI of the ASPSP

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{}

Get City List

Gets all cities currently supported in the Open Banking Platform.

Authorizations:
oAuth2oAuth2
query Parameters
isoCountryCodes
Array of strings (isoCountryCodes)
Example: isoCountryCodes=SE,FI

ISO Country Codes for the countries to get ASPSPs for

cityIds
Array of strings <uuid> (cityIds)
Example: cityIds=37efa883-c8ad-4ff7-927b-b11b02beb923,ba9dd929-1408-33a6-3ce2-bc45fcfaaa5c

City IDs for the countries to get ASPSPs for

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{
  • "cities": [
    ]
}

Get City Details

Gets a city by ID

Authorizations:
oAuth2oAuth2
path Parameters
city-id
required
string <uuid>
Example: 37efa883-c8ad-4ff7-927b-b11b02beb923

The ID of the city

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{
  • "cityId": "37efa883-c8ad-4ff7-927b-b11b02beb923",
  • "name": "Stockholm",
  • "isoCountryCode": "SE"
}

Get Country List

Gets all countries currently supported in the Open Banking Platform.

Authorizations:
oAuth2oAuth2
query Parameters
isoCountryCodes
Array of strings (isoCountryCodes)
Example: isoCountryCodes=SE,FI

ISO Country Codes for the countries to get ASPSPs for

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ]
}

Get Country Details

Gets a country by ISO Country Code

Authorizations:
oAuth2oAuth2
path Parameters
isoCountryCode
required
string^[a-zA-Z]{2,2}$
Example: SE

ISO Country Code for the country

header Parameters
X-Request-ID
required
string <uuid>
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.

Responses

Response samples

Content type
application/json
{
  • "isoCountryCode": "SE",
  • "name": "Sweden"
}

Consent Service

The Consent Service offers the following services:

  • Create and authorize consent between the PSU and the TPP
  • Get status of consent and retrieve previously authorized consents

Create Consent

This method creates 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 already exists 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 psd2 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:
oAuth2oAuth2
header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

X-AffiliatedASPSP-ID
string
Example: 8191

The ID of an affiliated ASPSP as related to the X-BicFi header

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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

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

Request samples

Content type
application/json
Example

Consent request on dedicated accounts

{
  • "access": {
    },
  • "recurringIndicator": "true",
  • "validUntil": "2022-09-02",
  • "frequencyPerDay": "4",
  • "combinedServiceIndicator": "false"
}

Response samples

Content type
application/json
Example

Consent request Response in case of a redirect

{
  • "consentStatus": "received",
  • "consentId": "1234-wertiq-983",
  • "_links": {}
}

Get Consent

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:
oAuth2oAuth2
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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json

Consent request on account list or without indication of accounts

{
  • "access": {
    },
  • "recurringIndicator": "true",
  • "validUntil": "2017-11-01",
  • "frequencyPerDay": "4",
  • "consentStatus": "valid",
  • "_links": {
    }
}

Delete Consent

The TPP can delete an account information consent object if needed.

Authorizations:
oAuth2oAuth2
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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
{
  • "tppMessages": [
    ],
  • "_links": {
    }
}

Get Consent Status

Read the status of an account information consent resource.

Authorizations:
oAuth2oAuth2
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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json

Response for a consent status request.

{
  • "consentStatus": "valid"
}

Start Consent Authorisation Process

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:
oAuth2oAuth2
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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "scaStatus": "received",
  • "authorisationId": "b391be2a-5fa0-4da5-afa7-6778d7ca2dc0",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links": {
    }
}

Get Consent Authorisation Sub-Resources

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:
oAuth2oAuth2
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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "authorisationIds": [
    ]
}

Get Consent Authorisation SCA Status

This method returns the SCA status of a consent initiation's authorisation sub-resource.

Authorizations:
oAuth2oAuth2
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: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "scaStatus": "psuAuthenticated",
  • "challengeData": {
    },
  • "tppMessages": [
    ]
}

Update PSU Data for Consent

This method updates 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:
oAuth2oAuth2
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: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
Example

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": {
    }
}

Account Information Service (AIS)

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 accessable accounts or card account relative to a granted consent

Get 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:
oAuth2oAuth2
query Parameters
withBalance
boolean

If present, this function reads the list of accessable 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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
Example

Response in case of an example, where the consent has been given on two different IBANs

{
  • "accounts": [
    ]
}

Get 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:
oAuth2oAuth2
path Parameters
account-id
required
string (accountId)
Example: qwer3456tzui7890

This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId 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 present, this function reads the list of accessable 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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
Example

Account Details for a regular Account

{
  • "account": {
    }
}

Get Balances

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:
oAuth2oAuth2
path Parameters
account-id
required
string (accountId)
Example: qwer3456tzui7890

This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId 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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
Example

Response for a read balance request in case of a regular account.

{
  • "account": {
    },
  • "balances": [
    ]
}

Get Transaction List

Read transaction reports or transaction lists of a given account addressed 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:
oAuth2oAuth2
path Parameters
account-id
required
string (accountId)
Example: qwer3456tzui7890

This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId 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

  • "booked",
  • "pending" and
  • "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend.
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 present, this function reads the list of accessable 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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
Example

Response in JSON format for an access on a regular account

{
  • "account": {
    },
  • "transactions": {
    }
}

Get Transaction Details

Reads transaction details from a given transaction addressed by "transactionId" on a given account addressed by "accountId". 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:
oAuth2oAuth2
path Parameters
account-id
required
string (accountId)
Example: qwer3456tzui7890

This identification is denoting the addressed account. The accountId is retrieved by using a "Read Account List" call. The accountId 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 <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json

Example for transaction details

{
  • "transactionsDetails": {
    }
}

Payment Initiation Service (PIS)

Payment Initiation Service (PIS) offers the following services:

  • Initiation and update of a payment request
  • Status information of a payment

Create Payment Initiation

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:
    • sepa-credit-transfers
    • domestic
    • international
    • swedish-giro

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

X-AffiliatedASPSP-ID
string
Example: 8191

The ID of an affiliated ASPSP as related to the X-BicFi header

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Request Body schema:

JSON request body for a payment initiation request message.

The following payment-products supported:

  • "sepa-credit-transfers" with JSON-Body
  • "domestic" with JSON-Body
  • "international" with JSON-Body
  • "swedish-giro" with JSON-Body

The following payment-services supported:

  • "payments"
  • "periodic-payments"
  • "bulk-paments"

All optional, conditional and predefined but not yet used fields are defined.

One of
endToEndIdentification
string <= 35 characters
required
object (accountReferenceWithGiro)

Reference to an account by either

  • IBAN, of a payment account, or
  • BBAN, for payment accounts if there is no IBAN, or,
  • BankGiro/PlusGiro for corporate Swedish accounts, or
  • the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
  • the Primary Account Number (PAN) of a card in a masked form, or
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
required
object (amount)
required
object (accountReference)

Reference to an account by either

  • IBAN, of a payment account, or
  • BBAN, for payment accounts if there is no IBAN, or
  • the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
  • the Primary Account Number (PAN) of a card in a masked form, or
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorAgent
string (bicfi) [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...

BICFI

creditorAgentName
string (creditorAgentName) <= 70 characters

Creditor Agent Name

creditorName
required
string (creditorName) <= 70 characters

Creditor Name

object (address)
remittanceInformationUnstructured
string (remittanceInformationUnstructured) <= 140 characters

Unstructured remittance information

debtorAccountMessage
string (debtorAccountMessage) <= 140 characters

Message for the debtor

requestedExecutionDate
string

Date when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30

Responses

Request samples

Content type
Example
{
  • "instructedAmount": {
    },
  • "debtorAccount": {
    },
  • "creditorName": "Merchant123",
  • "creditorAccount": {
    },
  • "remittanceInformationUnstructured": "Ref Number Merchant",
  • "debtorAccountMessage": "Personal note"
}

Response samples

Content type
application/json
Example

Response in case of a redirect with an implicitly created authorisation sub-resource

{
  • "transactionStatus": "RCVD",
  • "paymentId": "1234-wertiq-983",
  • "_links": {
    }
}

Get Payment Initiation

Returns the content of a payment object

Authorizations:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
Example
{
  • "endToEndIdentification": "string",
  • "debtorAccount": {
    },
  • "instructedAmount": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": "AAAADEBBXXX",
  • "creditorName": "Creditor Name",
  • "creditorAddress": {
    },
  • "remittanceInformationUnstructured": "Ref Number Merchant",
  • "remittanceInformationStructured": {
    },
  • "debtorAccountMessage": "Personal note",
  • "requestedExecutionDate": "string",
  • "transactionStatus": "ACCP",
  • "tppMessages": [
    ]
}

Cancel Payment Initiation

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "transactionStatus": "ACTC",
  • "_links": {
    }
}

Get Payment Initiation Status

Check the transaction status of a payment initiation.

Authorizations:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
Example
{
  • "transactionStatus": "ACCP"
}

Start Payment Initiation Authorisation Process

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

PSU-ID
string
Example: PSU-1234

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
required
object (psuData) non-empty

PSU Data for Update PSU Authentication.

Responses

Request samples

Content type
application/json
Example
{
  • "psuData": {
    }
}

Response samples

Content type
application/json
{
  • "scaStatus": "received",
  • "authorisationId": "b391be2a-5fa0-4da5-afa7-6778d7ca2dc0",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links": {
    }
}

Get Payment Initiation Authorisation Sub-Resources

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "authorisationIds": [
    ]
}

Get Payment Initiation Authorisation SCA Status

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

authorisationId
required
string (authorisationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "scaStatus": "psuAuthenticated",
  • "challengeData": {
    },
  • "tppMessages": [
    ]
}

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

authorisationId
required
string (authorisationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
Example

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": {
    }
}

Start Payment Initiation Cancellation Authorisation Process

Creates an authorisation sub-resource and starts 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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "scaStatus": "received",
  • "authorisationId": "b391be2a-5fa0-4da5-afa7-6778d7ca2dc0",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links": {
    }
}

Get Payment Initiation Cancellation Authorisation Sub-Resources

Retrieve a list of all created cancellation authorisation sub-resources.

Authorizations:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "cancellationIds": [
    ]
}

Get Payment Initiation Cancellation Authorisation SCA Status

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

cancellationId
required
string (cancellationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Identification for cancellation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "scaStatus": "psuAuthenticated",
  • "challengeData": {
    },
  • "tppMessages": [
    ]
}

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:
oAuth2oAuth2
path Parameters
payment-service
required
string
Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

  • payments
  • bulk-payments
  • periodic-payments
payment-product
required
string
Enum: "sepa-credit-transfers" "domestic" "international" "swedish-giro"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT).

The following payment products are supported:

  • sepa-credit-transfers
  • domestic
  • international
  • swedish-giro
paymentId
required
string (paymentId)
Example: 1234-wertiq-983

Resource identification of the generated payment initiation resource.

cancellationId
required
string (cancellationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Identification for cancellation resource.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
Example

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": {
    }
}

Create Signing Basket

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:
oAuth2oAuth2
header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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

Responses

Request samples

Content type
application/json

JSON Body of a signing basket request

{
  • "paymentIds": [
    ]
}

Response samples

Content type
application/json

Response (always with explicit authorisation start)

{
  • "transactionStatus": "RCVD",
  • "basketId": "c7197f20-4224-4c8c-b0fb-b3942105443b",
  • "_links": {
    }
}

Get Signing Basket

Returns the content of an signing basket object.

Authorizations:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "paymentIds": [
    ],
  • "transactionStatus": "ACTC"
}

Delete 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:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
{
  • "tppMessages": [
    ],
  • "_links": {
    }
}

Get Signing Basket Status

Returns the status of a signing basket object.

Authorizations:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "transactionStatus": "RCVD",
  • "tppMessages": [
    ]
}

Start Signing Basket Authorisation Process

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:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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.

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "scaStatus": "received",
  • "authorisationId": "b391be2a-5fa0-4da5-afa7-6778d7ca2dc0",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links": {
    }
}

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:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

authorisationId
required
string (authorisationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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. Is not contained 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.

PSU-ID-Type
string

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

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
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
One of
any

Responses

Request samples

Content type
application/json
Example
{ }

Response samples

Content type
application/json
Example

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": {
    }
}

Get Signing Basket Authorisation SCA Status

This method returns the SCA status of a signing basket's authorisation sub-resource.

Authorizations:
oAuth2oAuth2
path Parameters
basketId
required
string (basketId)
Example: c7197f20-4224-4c8c-b0fb-b3942105443b

This identification of the corresponding signing basket object.

authorisationId
required
string (authorisationId)
Example: b391be2a-5fa0-4da5-afa7-6778d7ca2dc0

Resource identification of the related SCA.

header Parameters
X-Request-ID
required
string <uuid>
Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

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

X-BicFi
required
string[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){...
Example: AAAADEBBXXX

BICFI

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:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
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
stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9...
Example: GEO:52.506931;13.144558

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

Responses

Response samples

Content type
application/json
{
  • "scaStatus": "psuAuthenticated",
  • "challengeData": {
    },
  • "tppMessages": [
    ]
}