Api documentation

Learn how to get started with our Api documentation

Documentation

API Reference - BGPSD2API 1.3 Dec 20th 2018 Json Yaml Try

# Summary The **NextGenPSD2** *Framework Version 1.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 Therefore for a particular implementation of a Berlin Group PSD2 compliant API it is only necessary to support a certain subset of the methods defined in this API definition. **Please have a look at the implementation guidelines if you are not sure which message has to be used for the approach you are going to use.** ## Some General Remarks Related to this version of the OpenAPI Specification: * **This API definition is based on the Implementation Guidelines of the Berlin Group PSD2 API.** It is not an replacement in any sense. The main specification is (at the moment) always the Implementation Guidelines of the Berlin Group PSD2 API. * **This API definition contains the REST-API for requests from the PISP to the ASPSP.** * **This API definition contains the messages for all different approaches defined in the Implementation Guidelines.** * According to the OpenAPI-Specification [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md] "If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored." The element "Accept" will not be defined in this file at any place. The elements "Content-Type" and "Authorization" are implicitly defined by the OpenApi tags "content" and "security". * There are several predefined types which might occur in payment initiation messages, but are not used in the standard JSON messages in the Implementation Guidelines. Therefore they are not used in the corresponding messages in this file either. We added them for the convenience of the user. If there is a payment product, which need these field, one can easily use the predefined types. But the ASPSP need not to accept them in general. * **We omit the definition of all standard HTTP header elements (mandatory/optional/conditional) except they are mention in the Implementation Guidelines.** Therefore the implementer might add the in his own realisation of a PSD2 comlient API in addition to the elements define in this file. ## 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 / - ? : ( ) . , ' + Space

Payment initiation request

POST /v1/{payment-service}/{payment-product}

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*** - ***instant-sepa-credit-transfers*** - ***target-2-payments*** - ***cross-border-credit-transfers*** - Payment products with payment information in *pain.001* XML format: - ***pain.001-sepa-credit-transfers*** - ***pain.001-instant-sepa-credit-transfers*** - ***pain.001-target-2-payments*** - ***pain.001-cross-border-credit-transfers*** Furthermore the request body depends on the **payment-service** * ***payments***: A single payment initiation request. * ***bulk-payments***: A collection of several payment iniatiation requests. In case of a *pain.001* message there are more than one payments contained in the *pain.001 message. In case of a *JSON* there are several JSON payment blocks contained in a joining list. * ***periodic-payments***: Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId} with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body. This is the first step in the API to initiate the related recurring/periodic payment. ## Single and mulitilevel SCA Processes The Payment Initiation Requests are independent from the need of one ore multilevel SCA processing, i.e. independent from the number of authorisations needed for the execution of payments. But the response messages are specific to either one SCA processing or multilevel SCA processing. For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation, i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the response message of a Payment Initation Request for a payment, where multiple authorisations are needed. Also if any data is needed for the next action, like selecting an SCA method is not supported in the response, since all starts of the multiple authorisations are fully equal. In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.

Consumes
application/json
Parameter Type/Format Description
payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

Consent-ID
optional

Header /

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.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
required

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Explicit-Authorisation-Preferred
optional

Header / string

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-Nok-Redirect-URI
optional

Header / string

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-Redirect-Preferred
optional

Header / string

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
optional

Header / string

URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 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-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

paymentInitiation
required

body /

JSON request body for a payment inition request message There are the following payment-products supported: * "sepa-credit-transfers" with JSON-Body * "instant-sepa-credit-transfers" with JSON-Body * "target-2-payments" with JSON-Body * "cross-border-credit-transfers" with JSON-Body * "pain.001-sepa-credit-transfers" with XML pain.001.001.03 body for SCT scheme * "pain.001-instant-sepa-credit-transfers" with XML pain.001.001.03 body for SCT INST scheme * "pain.001-target-2-payments" with pain.001 body. Only country specific schemes are currently available * "pain.001-cross-border-credit-transfers" with pain.001 body. Only country specific schemes are currently available There are the following payment-services supported: * "payments" * "periodic-payments" * "bulk-paments" All optional, conditional and predefined but not yet used fields are defined.

Sample Request

{
  "instructedAmount": {
    "currency": "EUR",
    "amount": "123.50"
  },
  "debtorAccount": {
    "iban": "DE40100100103307118608"
  },
  "creditorName": "Merchant123",
  "creditorAccount": {
    "iban": "DE02100100109307118603"
  },
  "remittanceInformationUnstructured": "Ref Number Merchant"
}

Response

405 - Method Not Allowed

404 - Not found

403 - Forbidden

201 - CREATED

400 - Bad Request

401 - Unauthorized 

{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/asdfasdfasdf"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/v1/payments/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "/v1/payments/1234-wertiq-983/authorisations/123auth456"
    }
  }
}

Create consent

POST /v1/consents

This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method as parameters as a core function. **Side Effects** When this Consent Request is a request where the "recurringIndicator" equals "true", and if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU. Optional Extension: As an option, an ASPSP might optionally accept a specific access right on the access on all 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.

Consumes
application/json
Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Explicit-Authorisation-Preferred
optional

Header / string

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-Nok-Redirect-URI
optional

Header / string

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-Redirect-Preferred
optional

Header / string

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
optional

Header / string

URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 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-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

consents
required

body / object

Requestbody for a consents request

Sample Request

{
  "access": {
    "balances": [
      {
        "iban": "DE40100100103307118608"
      },
      {
        "iban": "DE40100100103307118608"
      },
      {
        "iban": "DE02100100109307118603",
        "currency": "USD"
      },
      {
        "iban": "DE02100100109307118603",
        "currency": "USD"
      },
      {
        "iban": "DE67100100101306118605"
      },
      {
        "iban": "DE67100100101306118605"
      }
    ],
    "transactions": [
      {
        "iban": "DE40100100103307118608"
      },
      {
        "iban": "DE40100100103307118608"
      },
      {
        "maskedPan": "123456xxxxxx1234"
      },
      {
        "maskedPan": "123456xxxxxx1234"
      }
    ]
  },
  "recurringIndicator": "true",
  "validUntil": "2017-11-01",
  "frequencyPerDay": "4"
}

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

403 - Forbidden

401 - Unauthorized

400 - Bad Request

201 - Created

404 - Not found 

{
  "consentStatus": "received",
  "consentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/authentication/1234-wertiq-983"
    },
    "status": {
      "href": "/v1/consents/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "v1/consents/1234-wertiq-983/authorisations/123auth567"
    }
  }
}

Get Consent Request

GET /v1/consents/{consentId}

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.

Parameter Type/Format Description
consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "access": {
    "balances": [
      {
        "iban": "DE2310010010123456789"
      },
      {
        "iban": "DE2310010010123456789"
      }
    ],
    "transactions": [
      {
        "iban": "DE2310010010123456789"
      },
      {
        "iban": "DE2310010010123456789"
      },
      {
        "pan": "123456xxxxxx3457"
      },
      {
        "pan": "123456xxxxxx3457"
      }
    ]
  },
  "recurringIndicator": "true",
  "validUntil": "2017-11-01",
  "frequencyPerDay": "4",
  "consentStatus": "valid",
  "_links": {
    "account": {
      "href": "/v1/accounts"
    }
  }
}

Delete Consent

DELETE /v1/consents/{consentId}

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

Parameter Type/Format Description
consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

400 - Bad Request

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

Consent status request

GET /v1/consents/{consentId}/status

Read the status of an account information consent resource.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

400 - Bad Request

401 - Unauthorized

200 - OK 

{
  "consentStatus": "valid"
}

Get Consent Authorisation Sub-Resources Request

GET /v1/consents/{consentId}/authorisations

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.

Parameter Type/Format Description
consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "authorisationIds": [
    "123auth456"
  ]
}

Confirmation of Funds Request

POST /v1/funds-confirmations

Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively

Consumes
application/json
Parameter Type/Format Description
Digest
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

confirmationOfFunds
required

body / object

Request body for a confirmation of funds request.

Sample Request

{
  "cardNumber": "12345678901234",
  "account": {
    "iban": "DE23100120020123456789"
  },
  "instructedAmount": {
    "currency": "EUR",
    "amount": "123"
  }
}

Response

405 - Method Not Allowed

404 - Not found

403 - Forbidden

200 - OK

401 - Unauthorized

400 - Bad Request 

{
  "fundsAvailable": "true"
}

Create a signing basket resource

POST /v1/signing-baskets

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

Consumes
application/json
Parameter Type/Format Description
signingBasket
required

body / object

Request body for a confirmation of an establishing signing basket request

Consent-ID
optional

Header /

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.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
required

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Explicit-Authorisation-Preferred
optional

Header / string

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-Nok-Redirect-URI
optional

Header / string

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-Redirect-Preferred
optional

Header / string

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
optional

Header / string

URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach (including OAuth2 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-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Sample Request

{
  "paymentIds": [
    "123qwert456789",
    "12345qwert7899"
  ]
}

Response

401 - Unauthorized

201 - Created

400 - Bad Request

404 - Not found

403 - Forbidden

405 - Method Not Allowed 

{
  "transactionStatus": "RCVD",
  "basketId": "1234-basket-567",
  "_links": {
    "self": {
      "href": "/v1/signing-baskets/1234-basket-567"
    },
    "status": {
      "href": "/v1/signing-baskets/1234-basket-567/status"
    },
    "startAuthorisation": {
      "href": "/v1/signing-baskets/1234-basket-567/authorisations"
    }
  }
}

Returns the content of an signing basket object.

GET /v1/signing-baskets/{basketId}

Returns the content of an signing basket object.

Parameter Type/Format Description
basketId
required

Path /

This identification of the corresponding signing basket object.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed 

{
  "payments": [
    "1234pay567",
    "1234pay568",
    "1234pay888"
  ],
  "transactionStatus": "ACTC"
}

Read transaction list of an account

GET /v1/card-accounts/{account-id}/transactions

Reads account data from a given card account addressed by "account-id".

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

bookingStatus
required

Query / string

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

dateFrom
optional

Query / string

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
optional

Query / string

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.

deltaList
optional

Query / 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

entryReferenceFrom
optional

Query / 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.

withBalance
optional

Query / boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Response

200 - OK

401 - Unauthorized

400 - Bad Request

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

Read card account balances

GET /v1/card-accounts/{account-id}/balances

Reads balance data from a given card 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 Card Account List" call

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Response

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK

429 - Too Many Requests

Reads details about a card account

GET /v1/card-accounts/{account-id}

Reads details about a card account. 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.

Parameter Type/Format Description
account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "cardAccount": {
    "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
    "maskedPan": "525412******3241",
    "currency": "EUR",
    "name": "Main",
    "product": "Basic Credit",
    "status": "enabled",
    "creditLimit": {
      "currency": "EUR",
      "amount": "15000"
    },
    "balances": [
      {
        "balanceType": "interimBooked",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "14355.78"
        }
      },
      {
        "balanceType": "interimBooked",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "14355.78"
        }
      },
      {
        "balanceType": "nonBilled",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "4175.86"
        }
      },
      {
        "balanceType": "nonBilled",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "4175.86"
        }
      }
    ],
    "_links": {
      "transactions": {
        "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
      }
    }
  }
}

Reads a list of card accounts

GET /v1/card-accounts

Reads a list of card accounts with additional information, e.g. balance information. 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 card accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "cardAccounts": [
    {
      "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
      "maskedPan": "525412******3241",
      "currency": "EUR",
      "name": "Main",
      "product": "Basic Credit",
      "status": "enabled",
      "creditLimit": {
        "currency": "EUR",
        "amount": "15000"
      },
      "balances": [
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "nonBilled",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        },
        {
          "balanceType": "nonBilled",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        }
      ],
      "_links": {
        "transactions": {
          "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
        }
      }
    },
    {
      "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
      "maskedPan": "525412******3241",
      "currency": "EUR",
      "name": "Main",
      "product": "Basic Credit",
      "status": "enabled",
      "creditLimit": {
        "currency": "EUR",
        "amount": "15000"
      },
      "balances": [
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "nonBilled",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        },
        {
          "balanceType": "nonBilled",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        }
      ],
      "_links": {
        "transactions": {
          "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
        }
      }
    }
  ]
}

Get Payment Information

GET /v1/{payment-service}/{payment-product}/{paymentId}

Returns the content of a payment object

Parameter Type/Format Description
payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

401 - Unauthorized

400 - Bad Request

200 - OK

403 - Forbidden

405 - Method Not Allowed

404 - Not found

Payment Cancellation Request

DELETE /v1/{payment-service}/{payment-product}/{paymentId}

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.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Response

204 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

202 - Received 

{
  "transactionStatus": "CANC"
}

Payment initiation status request

GET /v1/{payment-service}/{payment-product}/{paymentId}/status

Check the transaction status of a payment initiation.

Parameter Type/Format Description
payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "transactionStatus": "ACCP"
}

Read Account List

GET /v1/accounts

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.

Parameter Type/Format Description
withBalance
optional

Query / boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

406 - Not Acceptable

429 - Too Many Requests 

{
  "accounts": [
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "DE2310010010123456789",
      "currency": "EUR",
      "product": "Girokonto",
      "cashAccountType": "CurrentAccount",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "DE2310010010123456789",
      "currency": "EUR",
      "product": "Girokonto",
      "cashAccountType": "CurrentAccount",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "DE2310010010123456788",
      "currency": "USD",
      "product": "Fremdw?hrungskonto",
      "cashAccountType": "CurrentAccount",
      "name": "US Dollar Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "DE2310010010123456788",
      "currency": "USD",
      "product": "Fremdw?hrungskonto",
      "cashAccountType": "CurrentAccount",
      "name": "US Dollar Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    }
  ]
}

Read Account Details

GET /v1/accounts/{account-id}

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

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

withBalance
optional

Query / boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Response

403 - Forbidden

404 - Not found

405 - Method Not Allowed

406 - Not Acceptable

429 - Too Many Requests

401 - Unauthorized

400 - Bad Request

200 - OK 

{
  "account": {
    "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
    "iban": "FR7612345987650123456789014",
    "currency": "EUR",
    "product": "Girokonto",
    "cashAccountType": "CurrentAccount",
    "name": "Main Account",
    "_links": {
      "balances": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
      },
      "transactions": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
      }
    }
  }
}

Read Balance

GET /v1/accounts/{account-id}/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.

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Response

429 - Too Many Requests

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

406 - Not Acceptable 

{
  "account": {
    "iban": "FR7612345987650123456789014"
  },
  "balances": [
    {
      "balanceType": "closingBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "500.00"
      },
      "referenceDate": "2017-10-25"
    },
    {
      "balanceType": "closingBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "500.00"
      },
      "referenceDate": "2017-10-25"
    },
    {
      "balanceType": "expected",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "900.00"
      },
      "lastChangeDateTime": "2017-10-25T15:30:35.035Z"
    },
    {
      "balanceType": "expected",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "900.00"
      },
      "lastChangeDateTime": "2017-10-25T15:30:35.035Z"
    }
  ]
}

Read transaction list of an account

GET /v1/accounts/{account-id}/transactions/

Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances. For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.

Parameter Type/Format Description
bookingStatus
required

Query / string

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

dateFrom
optional

Query / string

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
optional

Query / string

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.

deltaList
optional

Query / 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

entryReferenceFrom
optional

Query / 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.

withBalance
optional

Query / boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

400 - Bad Request

200 - OK

401 - Unauthorized 

{
  "account": {
    "iban": "DE2310010010123456788"
  },
  "transactions": {
    "booked": [
      {
        "transactionId": "1234567",
        "creditorName": "John Miles",
        "creditorAccount": {
          "iban": "DE67100100101306118605"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "256.67"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 1"
      },
      {
        "transactionId": "1234567",
        "creditorName": "John Miles",
        "creditorAccount": {
          "iban": "DE67100100101306118605"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "256.67"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 1"
      },
      {
        "transactionId": "1234568",
        "debtorName": "Paul Simpson",
        "debtorAccount": {
          "iban": "NL76RABO0359400371"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "343.01"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 2"
      },
      {
        "transactionId": "1234568",
        "debtorName": "Paul Simpson",
        "debtorAccount": {
          "iban": "NL76RABO0359400371"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "343.01"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 2"
      }
    ],
    "pending": [
      {
        "transactionId": "1234569",
        "creditorName": "Claude Renault",
        "creditorAccount": {
          "iban": "FR7612345987650123456789014"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "-100.03"
        },
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 3"
      },
      {
        "transactionId": "1234569",
        "creditorName": "Claude Renault",
        "creditorAccount": {
          "iban": "FR7612345987650123456789014"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "-100.03"
        },
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 3"
      }
    ],
    "_links": {
      "account": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f"
      }
    }
  }
}

Read Transaction Details

GET /v1/accounts/{account-id}/transactions/{resourceId}

Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "account-id". This call is only available on transactions as reported in a JSON format. **Remark:** Please note that the PATH might be already given in detail by the corresponding entry of the response of the "Read Transaction List" call within the _links subfield.

Parameter Type/Format Description
Consent-ID
required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

account-id
required

Path /

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

resourceId
required

Path /

This identification is given by the attribute resourceId of the corresponding entry of a transaction list.

Response

200 - OK

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request 

{
  "transactionsDetails": {
    "transactionId": "1234567",
    "creditorName": "John Miles",
    "creditorAccount": {
      "iban": "DE67100100101306118605"
    },
    "mandateId": "Mandate-2018-04-20-1234",
    "transactionAmount": {
      "currency": "EUR",
      "amount": "-256.67"
    },
    "bookingDate": "2017-10-25",
    "valueDate": "2017-10-26",
    "remittanceInformationUnstructured": "Example 1",
    "bankTransactionCode": "PMNT-RCVD-ESDD"
  }
}

Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.

GET /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

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

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Response

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

200 - OK

400 - Bad Request 

{
  "cancellationIds": [
    "123auth456"
  ]
}

Start the authorisation process for a consent

POST /v1/consents/{consentId}/authorisations

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 preceeding 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' #TODO * '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 preceeding 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.

Parameter Type/Format Description
consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

429 - Too Many Requests

400 - Bad Request

404 - Not found

403 - Forbidden

401 - Unauthorized

201 - Created

405 - Method Not Allowed

406 - Not Acceptable 

{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Read the SCA status of the consent authorisation.

GET /v1/consents/{consentId}/authorisations/{authorisationId}

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

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

authorisationId
required

Path /

Resource identification of the related SCA.

consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Response

429 - Too Many Requests

406 - Not Acceptable

405 - Method Not Allowed

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

Update PSU Data for consents

PUT /v1/consents/{consentId}/authorisations/{authorisationId}

This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed. Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication. This methods updates PSU data on the cancellation authorisation resource if needed. There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach: * Redirect SCA Approach: A specific Update PSU Data Request is applicable for * the selection of authentication methods, before choosing the actual SCA approach. * Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for * adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or * the selection of authentication methods. * Embedded SCA Approach: The Update PSU Data Request might be used * to add credentials as a first factor authentication data of the PSU and * to select the authentication method and * transaction authorisation. The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches: * Select an SCA method in case of several SCA methods are available for the customer. There are the following request types on this access path: * Update PSU Identification * Update PSU Authentication * Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change. * Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Consumes
application/json
Parameter Type/Format Description
authorisationId
required

Path /

Resource identification of the related SCA.

consentId
required

Path /

ID of the corresponding consent object as returned by an Account Information Consent Request.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

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
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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


required

body /

Sample Request

{}

Response

429 - Too Many Requests

405 - Method Not Allowed

406 - Not Acceptable

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found 

{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Delete the signing basket

DELETE /v1/signing-baskets/{basketId}

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.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

basketId
required

Path /

This identification of the corresponding signing basket object.

Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

Read the status of the signing basket

GET /v1/signing-baskets/{basketId}/status

Returns the status of a signing basket object.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

basketId
required

Path /

This identification of the corresponding signing basket object.

Response

405 - Method Not Allowed

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK

Start the authorisation process for a signing basket

POST /v1/signing-baskets/{basketId}/authorisations

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 preceeding 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' #TODO * '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 preceeding 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.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

basketId
required

Path /

This identification of the corresponding signing basket object.

Response

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

201 - Created 

{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Get Signing Basket Authorisation Sub-Resources Request

GET /v1/signing-baskets/{basketId}/authorisations

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.

Parameter Type/Format Description
basketId
required

Path /

This identification of the corresponding signing basket object.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed 

{
  "authorisationIds": [
    "123auth456"
  ]
}

Start the authorisation process for a payment initiation

POST /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

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 preceeding 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' #TODO * '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 preceeding 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.

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Response

201 - Created

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed 

{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Get Payment Initiation Authorisation Sub-Resources Request

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

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.

Parameter Type/Format Description
payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

405 - Method Not Allowed

200 - OK

403 - Forbidden

401 - Unauthorized

404 - Not found

400 - Bad Request 

{
  "authorisationIds": [
    "123auth456"
  ]
}

Read the SCA Status of the payment authorisation

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

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

Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

authorisationId
required

Path /

Resource identification of the related SCA.

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Response

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

200 - OK

400 - Bad Request

Update PSU data for payment initiation

PUT /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

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.

Consumes
application/json
Parameter Type/Format Description
authorisationId
required

Path /

Resource identification of the related SCA.

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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


required

body /

Sample Request

{}

Response

200 - OK

400 - Bad Request

401 - Unauthorized

404 - Not found

405 - Method Not Allowed

403 - Forbidden 

{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Update PSU Data for signing basket

PUT /v1/signing-baskets/{basketId}/authorisations/{authorisationId}

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.

Consumes
application/json
Parameter Type/Format Description
Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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


required

body /

authorisationId
required

Path /

Resource identification of the related SCA.

basketId
required

Path /

This identification of the corresponding signing basket object.

Sample Request

{}

Response

405 - Method Not Allowed

404 - Not found

401 - Unauthorized

400 - Bad Request

200 - OK

403 - Forbidden 

{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Start the authorisation process for the cancellation of the addressed payment

POST /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit authentication and authorisation related data. This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the cancellation-authorisation. The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call. The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource. This applies in the following scenarios: * The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceeding 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' #TODO * '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 preceeding 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.

Parameter Type/Format Description
payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

404 - Not found

405 - Method Not Allowed

401 - Unauthorized

403 - Forbidden

201 - Created

400 - Bad Request 

{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Read the SCA status of the payment cancellation's authorisation.

GET /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}

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

Parameter Type/Format Description
cancellationId
required

Path /

Identification for cancellation resource.

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not found

405 - Method Not Allowed

400 - Bad Request

Update PSU Data for payment initiation cancellation

PUT /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}

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.

Consumes
application/json
Parameter Type/Format Description
cancellationId
required

Path /

Identification for cancellation resource.

payment-product
required

Path / string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers - pain.001-sepa-credit-transfers - pain.001-instant-sepa-credit-transfers - pain.001-target-2-payments - pain.001-cross-border-credit-transfers **Remark:** For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. **Remark:** For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

payment-service
required

Path / string

Payment service: Possible values are: * payments * bulk-payments * periodic-payments

paymentId
required

Path /

Resource identification of the generated payment initiation resource.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Corporate-ID
optional

Header / string

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

PSU-Corporate-ID-Type
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-ID
optional

Header / string

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 preceeding AIS service in the same session.

PSU-ID-Type
optional

Header / string

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

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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


required

body /

Sample Request

{}

Response

200 - OK

400 - Bad Request

401 - Unauthorized

404 - Not found

405 - Method Not Allowed

403 - Forbidden 

{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Read the SCA status of the signing basket authorisation

GET /v1/signing-baskets/{basketId}/authorisations/{authorisationId}

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

Parameter Type/Format Description
authorisationId
required

Path /

Resource identification of the related SCA.

basketId
required

Path /

This identification of the corresponding signing basket object.

Digest
optional

Header / string

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

PSU-Accept
optional

Header / 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
optional

Header / 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
optional

Header / 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
optional

Header / string

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

PSU-Device-ID
optional

Header / string

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
optional

Header / string

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

PSU-Http-Method
optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE

PSU-IP-Address
optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
optional

Header / string

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

PSU-User-Agent
optional

Header / string

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

Signature
optional

Header / string

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

TPP-Signature-Certificate
optional

Header / string

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

X-Request-ID
required

Header / string

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

Response

404 - Not found

403 - Forbidden

401 - Unauthorized

400 - Bad Request

200 - OK

405 - Method Not Allowed