NextGenPSD2 XS2A Framework

Summary

The NextGenPSD2 Framework Version 1.3.4 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:

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:

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

More information: https://www.berlin-group.org/
Contact Info: info@berlin-group.org
Version: 1.3.4_2019-07-17v1
BasePath:/psd2
Creative Commons Attribution 4.0 International Public License
https://creativecommons.org/licenses/by/4.0/

Access

Methods

[ Jump to Models ]

Table of Contents

AccountInformationServiceAIS

CommonServices

ConfirmationOfFundsServicePIIS

PaymentInitiationServicePIS

SigningBasketsSBS

AccountInformationServiceAIS

Up
post /v1/consents
Create consent (createConsent)
<p>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.</p> <p><strong>Side Effects</strong> When this Consent Request is a request where the &quot;recurringIndicator&quot; equals &quot;true&quot;, 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.</p> <p>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.</p> <p>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</p> <ul> <li>to see the list of available payment accounts or</li> <li>to see the list of available payment accounts with balances.</li> </ul>

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body consents (optional)
Body Parameter — Requestbody for a consents request
example: { "$ref" : "#/components/examples/consentsExample_DedicatedAccounts" }

Request headers

Return type

consentsResponse-201

Example data

Content-Type: application/json
{
  "consentId" : "consentId",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "consentStatus" : "received",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created consentsResponse-201

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
delete /v1/consents/{consentId}
Delete Consent (deleteConsent)
The TPP can delete an account information consent object if needed.

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/accounts
Read Account List (getAccountList)
<p>Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.</p> <p>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.</p> <p>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.</p> <p>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.</p>

Request headers

Query parameters

withBalance (optional)
Query Parameter — 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.

Return type

accountList

Example data

Content-Type: application/json
{
  "accounts" : [ {
    "cashAccountType" : "cashAccountType",
    "resourceId" : "resourceId",
    "product" : "product",
    "bban" : "BARC12345612345678",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "iban" : "FR7612345987650123456789014",
    "name" : "name",
    "linkedAccounts" : "linkedAccounts",
    "currency" : "EUR",
    "details" : "details",
    "msisdn" : "+49 170 1234567",
    "bic" : "AAAADEBBXXX",
    "status" : "enabled"
  }, {
    "cashAccountType" : "cashAccountType",
    "resourceId" : "resourceId",
    "product" : "product",
    "bban" : "BARC12345612345678",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "iban" : "FR7612345987650123456789014",
    "name" : "name",
    "linkedAccounts" : "linkedAccounts",
    "currency" : "EUR",
    "details" : "details",
    "msisdn" : "+49 170 1234567",
    "bic" : "AAAADEBBXXX",
    "status" : "enabled"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK accountList

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/accounts/{account-id}/balances
Read Balance (getBalances)
<p>Reads account data from a given account addressed by &quot;account-id&quot;.</p> <p><strong>Remark:</strong> 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 &quot;GET Account List&quot; call.</p> <p>The account-id is constant at least throughout the lifecycle of a given consent.</p>

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Return type

readAccountBalanceResponse-200

Example data

Content-Type: application/json
{
  "balances" : [ {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  }, {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  } ],
  "account" : {
    "bban" : "BARC12345612345678",
    "maskedPan" : "123456xxxxxx1234",
    "iban" : "FR7612345987650123456789014",
    "currency" : "EUR",
    "pan" : "5409050000000000",
    "msisdn" : "+49 170 1234567"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK readAccountBalanceResponse-200

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/card-accounts
Reads a list of card accounts (getCardAccount)
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.

Request headers

Return type

cardAccountList

Example data

Content-Type: application/json
{
  "cardAccounts" : [ {
    "resourceId" : "resourceId",
    "product" : "product",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "maskedPan" : "123456xxxxxx1234",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "name" : "name",
    "creditLimit" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "currency" : "EUR",
    "details" : "details",
    "status" : "enabled"
  }, {
    "resourceId" : "resourceId",
    "product" : "product",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "maskedPan" : "123456xxxxxx1234",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "name" : "name",
    "creditLimit" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "currency" : "EUR",
    "details" : "details",
    "status" : "enabled"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK cardAccountList

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/card-accounts/{account-id}/balances
Read card account balances (getCardAccountBalances)
<p>Reads balance data from a given card account addressed by &quot;account-id&quot;.</p> <p>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 &quot;GET Card Account List&quot; call</p>

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Return type

readCardAccountBalanceResponse-200

Example data

Content-Type: application/json
{
  "balances" : [ {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  }, {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  } ],
  "cardAccount" : {
    "bban" : "BARC12345612345678",
    "maskedPan" : "123456xxxxxx1234",
    "iban" : "FR7612345987650123456789014",
    "currency" : "EUR",
    "pan" : "5409050000000000",
    "msisdn" : "+49 170 1234567"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK readCardAccountBalanceResponse-200

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/card-accounts/{account-id}/transactions
Read transaction list of an account (getCardAccountTransactionList)
Reads account data from a given card account addressed by &quot;account-id&quot;.

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Query parameters

dateFrom (optional)
Query Parameter — <p>Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.</p> <p>For booked transactions, the relevant date is the booking date.</p> <p>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.</p> format: date
dateTo (optional)
Query Parameter — <p>End date (inclusive the data dateTo) of the transaction list, default is &quot;now&quot; if not given.</p> <p>Might be ignored if a delta function is used.</p> <p>For booked transactions, the relevant date is the booking date.</p> <p>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.</p> format: date
entryReferenceFrom (optional)
Query Parameter — <p>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 &quot;dateFrom&quot; and &quot;dateTo&quot; might be ignored by the ASPSP if a delta report is supported.</p> <p>Optional if supported by API provider.</p>
bookingStatus (required)
Query Parameter — <p>Permitted codes are</p> <ul> <li>&quot;booked&quot;,</li> <li>&quot;pending&quot; and</li> <li>&quot;both&quot; &quot;booked&quot; shall be supported by the ASPSP. To support the &quot;pending&quot; and &quot;both&quot; feature is optional for the ASPSP, Error code if not supported in the online banking frontend</li> </ul>
deltaList (optional)
Query Parameter — This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
withBalance (optional)
Query Parameter — 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.

Return type

cardAccountsTransactionsResponse200

Example data

Content-Type: application/json
{
  "balances" : [ {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  }, {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  } ],
  "_links" : { },
  "cardTransactions" : {
    "booked" : [ {
      "cardAcceptorId" : "cardAcceptorId",
      "transactionDetails" : "transactionDetails",
      "maskedPAN" : "123456xxxxxx1234",
      "invoiced" : true,
      "cardAcceptorAddress" : {
        "street" : "rue blue",
        "buildingnNumber" : "89",
        "city" : "Paris",
        "postalCode" : "75000",
        "country" : "FR"
      },
      "terminalId" : "terminalId",
      "transactionDate" : "2000-01-23",
      "cardTransactionId" : "cardTransactionId",
      "currencyExchange" : [ {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      }, {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      } ],
      "transactionAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "merchantCategoryCode" : "merchantCategoryCode",
      "proprietaryBankTransactionCode" : "proprietaryBankTransactionCode",
      "bookingDate" : "2000-01-23",
      "markupFeePercentage" : "0.3"
    }, {
      "cardAcceptorId" : "cardAcceptorId",
      "transactionDetails" : "transactionDetails",
      "maskedPAN" : "123456xxxxxx1234",
      "invoiced" : true,
      "cardAcceptorAddress" : {
        "street" : "rue blue",
        "buildingnNumber" : "89",
        "city" : "Paris",
        "postalCode" : "75000",
        "country" : "FR"
      },
      "terminalId" : "terminalId",
      "transactionDate" : "2000-01-23",
      "cardTransactionId" : "cardTransactionId",
      "currencyExchange" : [ {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      }, {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      } ],
      "transactionAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "merchantCategoryCode" : "merchantCategoryCode",
      "proprietaryBankTransactionCode" : "proprietaryBankTransactionCode",
      "bookingDate" : "2000-01-23",
      "markupFeePercentage" : "0.3"
    } ],
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    }
  },
  "cardAccount" : {
    "bban" : "BARC12345612345678",
    "maskedPan" : "123456xxxxxx1234",
    "iban" : "FR7612345987650123456789014",
    "currency" : "EUR",
    "pan" : "5409050000000000",
    "msisdn" : "+49 170 1234567"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK cardAccountsTransactionsResponse200

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/consents/{consentId}/authorisations
Get Consent Authorisation Sub-Resources Request (getConsentAuthorisation)
<p>Return a list of all authorisation subresources IDs which have been created.</p> <p>This function returns an array of hyperlinks to all generated authorisation sub-resources.</p>

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Request headers

Return type

authorisations

Example data

Content-Type: application/json
{
  "authorisationIds" : [ "123auth456", "123auth456" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK authorisations

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/consents/{consentId}
Get Consent Request (getConsentInformation)
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.

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Request headers

Return type

consentInformationResponse-200_json

Example data

Content-Type: application/json
{
  "access" : {
    "balances" : [ null, null ],
    "availableAccounts" : "allAccounts",
    "availableAccountsWithBalance" : "allAccounts",
    "accounts" : [ {
      "bban" : "BARC12345612345678",
      "maskedPan" : "123456xxxxxx1234",
      "iban" : "FR7612345987650123456789014",
      "currency" : "EUR",
      "pan" : "5409050000000000",
      "msisdn" : "+49 170 1234567"
    }, {
      "bban" : "BARC12345612345678",
      "maskedPan" : "123456xxxxxx1234",
      "iban" : "FR7612345987650123456789014",
      "currency" : "EUR",
      "pan" : "5409050000000000",
      "msisdn" : "+49 170 1234567"
    } ],
    "transactions" : [ null, null ],
    "allPsd2" : "allAccounts"
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "consentStatus" : "received",
  "validUntil" : "2020-12-31T00:00:00.000+0000",
  "recurringIndicator" : false,
  "lastActionDate" : "2018-07-01T00:00:00.000+0000",
  "frequencyPerDay" : 4
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK consentInformationResponse-200_json

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/consents/{consentId}/authorisations/{authorisationId}
Read the SCA status of the consent authorisation. (getConsentScaStatus)
This method returns the SCA status of a consent initiation's authorisation sub-resource.

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/consents/{consentId}/status
Consent status request (getConsentStatus)
Read the status of an account information consent resource.

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Request headers

Return type

consentStatusResponse-200

Example data

Content-Type: application/json
{
  "consentStatus" : "received"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK consentStatusResponse-200

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/accounts/{account-id}/transactions/{transactionId}
Read Transaction Details (getTransactionDetails)
<p>Reads transaction details from a given transaction addressed by &quot;transactionId&quot; on a given account addressed by &quot;account-id&quot;. This call is only available on transactions as reported in a JSON format.</p> <p><strong>Remark:</strong> Please note that the PATH might be already given in detail by the corresponding entry of the response of the &quot;Read Transaction List&quot; call within the _links subfield.</p>

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
transactionId (required)
Path Parameter — This identification is given by the attribute transactionId of the corresponding entry of a transaction list.

Request headers

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "transactionsDetails" : {
    "additionalInformation" : "additionalInformation",
    "creditorName" : "Creditor Name",
    "remittanceInformationStructured" : "remittanceInformationStructured",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "ultimateCreditor" : "Ultimate Creditor",
    "bankTransactionCode" : "PMNT-RCDT-ESCT",
    "debtorName" : "Debtor Name",
    "valueDate" : "2000-01-23",
    "endToEndId" : "endToEndId",
    "transactionId" : "transactionId",
    "currencyExchange" : [ {
      "contractIdentification" : "contractIdentification",
      "exchangeRate" : "exchangeRate",
      "unitCurrency" : "unitCurrency",
      "sourceCurrency" : "EUR",
      "quotationDate" : "2000-01-23"
    }, {
      "contractIdentification" : "contractIdentification",
      "exchangeRate" : "exchangeRate",
      "unitCurrency" : "unitCurrency",
      "sourceCurrency" : "EUR",
      "quotationDate" : "2000-01-23"
    } ],
    "ultimateDebtor" : "Ultimate Debtor",
    "mandateId" : "mandateId",
    "transactionAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "purposeCode" : "BKDF",
    "proprietaryBankTransactionCode" : "proprietaryBankTransactionCode",
    "bookingDate" : "2000-01-23",
    "remittanceInformationUnstructured" : "Ref Number Merchant",
    "checkId" : "checkId",
    "entryReference" : "entryReference",
    "creditorId" : "creditorId"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_1

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/accounts/{account-id}/transactions
Read transaction list of an account (getTransactionList)
<p>Read transaction reports or transaction lists of a given account ddressed by &quot;account-id&quot;, depending on the steering parameter &quot;bookingStatus&quot; together with balances.</p> <p>For a given account, additional parameters are e.g. the attributes &quot;dateFrom&quot; and &quot;dateTo&quot;. The ASPSP might add balance information, if transaction lists without balances are not supported.</p>

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Query parameters

dateFrom (optional)
Query Parameter — <p>Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.</p> <p>For booked transactions, the relevant date is the booking date.</p> <p>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.</p> format: date
dateTo (optional)
Query Parameter — <p>End date (inclusive the data dateTo) of the transaction list, default is &quot;now&quot; if not given.</p> <p>Might be ignored if a delta function is used.</p> <p>For booked transactions, the relevant date is the booking date.</p> <p>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.</p> format: date
entryReferenceFrom (optional)
Query Parameter — <p>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 &quot;dateFrom&quot; and &quot;dateTo&quot; might be ignored by the ASPSP if a delta report is supported.</p> <p>Optional if supported by API provider.</p>
bookingStatus (required)
Query Parameter — <p>Permitted codes are</p> <ul> <li>&quot;booked&quot;,</li> <li>&quot;pending&quot; and</li> <li>&quot;both&quot; &quot;booked&quot; shall be supported by the ASPSP. To support the &quot;pending&quot; and &quot;both&quot; feature is optional for the ASPSP, Error code if not supported in the online banking frontend</li> </ul>
deltaList (optional)
Query Parameter — This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
withBalance (optional)
Query Parameter — 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.

Return type

transactionsResponse-200_json

Example data

Content-Type: application/json
{
  "balances" : [ {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  }, {
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : false,
    "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
    "lastCommittedTransaction" : "lastCommittedTransaction",
    "balanceAmount" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "referenceDate" : "2000-01-23"
  } ],
  "_links" : { },
  "transactions" : {
    "booked" : [ {
      "additionalInformation" : "additionalInformation",
      "creditorName" : "Creditor Name",
      "remittanceInformationStructured" : "remittanceInformationStructured",
      "_links" : {
        "key" : {
          "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
        }
      },
      "ultimateCreditor" : "Ultimate Creditor",
      "bankTransactionCode" : "PMNT-RCDT-ESCT",
      "debtorName" : "Debtor Name",
      "valueDate" : "2000-01-23",
      "endToEndId" : "endToEndId",
      "transactionId" : "transactionId",
      "currencyExchange" : [ {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      }, {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      } ],
      "ultimateDebtor" : "Ultimate Debtor",
      "mandateId" : "mandateId",
      "transactionAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "purposeCode" : "BKDF",
      "proprietaryBankTransactionCode" : "proprietaryBankTransactionCode",
      "bookingDate" : "2000-01-23",
      "remittanceInformationUnstructured" : "Ref Number Merchant",
      "checkId" : "checkId",
      "entryReference" : "entryReference",
      "creditorId" : "creditorId"
    }, {
      "additionalInformation" : "additionalInformation",
      "creditorName" : "Creditor Name",
      "remittanceInformationStructured" : "remittanceInformationStructured",
      "_links" : {
        "key" : {
          "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
        }
      },
      "ultimateCreditor" : "Ultimate Creditor",
      "bankTransactionCode" : "PMNT-RCDT-ESCT",
      "debtorName" : "Debtor Name",
      "valueDate" : "2000-01-23",
      "endToEndId" : "endToEndId",
      "transactionId" : "transactionId",
      "currencyExchange" : [ {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      }, {
        "contractIdentification" : "contractIdentification",
        "exchangeRate" : "exchangeRate",
        "unitCurrency" : "unitCurrency",
        "sourceCurrency" : "EUR",
        "quotationDate" : "2000-01-23"
      } ],
      "ultimateDebtor" : "Ultimate Debtor",
      "mandateId" : "mandateId",
      "transactionAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "purposeCode" : "BKDF",
      "proprietaryBankTransactionCode" : "proprietaryBankTransactionCode",
      "bookingDate" : "2000-01-23",
      "remittanceInformationUnstructured" : "Ref Number Merchant",
      "checkId" : "checkId",
      "entryReference" : "entryReference",
      "creditorId" : "creditorId"
    } ],
    "_links" : { }
  },
  "account" : {
    "bban" : "BARC12345612345678",
    "maskedPan" : "123456xxxxxx1234",
    "iban" : "FR7612345987650123456789014",
    "currency" : "EUR",
    "pan" : "5409050000000000",
    "msisdn" : "+49 170 1234567"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK transactionsResponse-200_json

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/accounts/{account-id}
Read Account Details (readAccountDetails)
<p>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.</p> <p><strong>NOTE:</strong> The account-id can represent a multicurrency account. In this case the currency code is set to &quot;XXX&quot;.</p> <p>Give detailed information about the addressed account.</p> <p>Give detailed information about the addressed account together with balance information</p>

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Query parameters

withBalance (optional)
Query Parameter — 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.

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "account" : {
    "cashAccountType" : "cashAccountType",
    "resourceId" : "resourceId",
    "product" : "product",
    "bban" : "BARC12345612345678",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "iban" : "FR7612345987650123456789014",
    "name" : "name",
    "linkedAccounts" : "linkedAccounts",
    "currency" : "EUR",
    "details" : "details",
    "msisdn" : "+49 170 1234567",
    "bic" : "AAAADEBBXXX",
    "status" : "enabled"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/card-accounts/{account-id}
Reads details about a card account (readCardAccount)
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.

Path parameters

account-id (required)
Path Parameter — This identification is denoting the addressed account. The account-id is retrieved by using a &quot;Read Account List&quot; call. The account-id is the &quot;id&quot; attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

Request headers

Return type

inline_response_200_2

Example data

Content-Type: application/json
{
  "cardAccount" : {
    "resourceId" : "resourceId",
    "product" : "product",
    "balances" : [ {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    }, {
      "balanceType" : "closingBooked",
      "creditLimitIncluded" : false,
      "lastChangeDateTime" : "2000-01-23T04:56:07.000+00:00",
      "lastCommittedTransaction" : "lastCommittedTransaction",
      "balanceAmount" : {
        "currency" : "EUR",
        "amount" : "123"
      },
      "referenceDate" : "2000-01-23"
    } ],
    "maskedPan" : "123456xxxxxx1234",
    "_links" : {
      "key" : {
        "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
      }
    },
    "usage" : "PRIV",
    "name" : "name",
    "creditLimit" : {
      "currency" : "EUR",
      "amount" : "123"
    },
    "currency" : "EUR",
    "details" : "details",
    "status" : "enabled"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_2

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
post /v1/consents/{consentId}/authorisations
Start the authorisation process for a consent (startConsentAuthorisation)
<p>Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
put /v1/consents/{consentId}/authorisations/{authorisationId}
Update PSU Data for consents (updateConsentsPsuData)
<p>This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

CommonServices

Up
delete /v1/signing-baskets/{basketId}
Delete the signing basket (deleteSigningBasket)
<p>Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.</p> <p>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.</p>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/consents/{consentId}/authorisations/{authorisationId}
Read the SCA status of the consent authorisation. (getConsentScaStatus)
This method returns the SCA status of a consent initiation's authorisation sub-resource.

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}
Read the SCA status of the payment cancellation's authorisation. (getPaymentCancellationScaStatus)
This method returns the SCA status of a payment initiation's authorisation sub-resource.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
cancellationId (required)
Path Parameter — Identification for cancellation resource.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/authorisations
Get Payment Initiation Authorisation Sub-Resources Request (getPaymentInitiationAuthorisation)
<p>Read a list of all authorisation subresources IDs which have been created.</p> <p>This function returns an array of hyperlinks to all generated authorisation sub-resources.</p>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

authorisations

Example data

Content-Type: application/json
{
  "authorisationIds" : [ "123auth456", "123auth456" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK authorisations

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
Read the SCA Status of the payment authorisation (getPaymentInitiationScaStatus)
This method returns the SCA status of a payment initiation's authorisation sub-resource.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/authorisations
Get Signing Basket Authorisation Sub-Resources Request (getSigningBasketAuthorisation)
<p>Read a list of all authorisation subresources IDs which have been created.</p> <p>This function returns an array of hyperlinks to all generated authorisation sub-resources.</p>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Return type

authorisations

Example data

Content-Type: application/json
{
  "authorisationIds" : [ "123auth456", "123auth456" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK authorisations

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/authorisations/{authorisationId}
Read the SCA status of the signing basket authorisation (getSigningBasketScaStatus)
This method returns the SCA status of a signing basket's authorisation sub-resource.

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/status
Read the status of the signing basket (getSigningBasketStatus)
Returns the status of a signing basket object.

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Return type

signingBasketStatusResponse-200

Example data

Content-Type: application/json
{
  "transactionStatus" : "RCVD"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK signingBasketStatusResponse-200

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/consents/{consentId}/authorisations
Start the authorisation process for a consent (startConsentAuthorisation)
<p>Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
post /v1/{payment-service}/{payment-product}/{paymentId}/authorisations
Start the authorisation process for a payment initiation (startPaymentAuthorisation)
<p>Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
Start the authorisation process for the cancellation of the addressed payment (startPaymentInitiationCancellationAuthorisation)
<p>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.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/signing-baskets/{basketId}/authorisations
Start the authorisation process for a signing basket (startSigningBasketAuthorisation)
<p>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.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/consents/{consentId}/authorisations/{authorisationId}
Update PSU Data for consents (updateConsentsPsuData)
<p>This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

consentId (required)
Path Parameter — ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_AIS

403

Forbidden Error403_NG_AIS

404

Not found Error404_NG_AIS

405

Method Not Allowed Error405_NG_AIS

406

Not Acceptable Error406_NG_AIS

408

Request Timeout

409

Conflict Error409_NG_AIS

415

Unsupported Media Type

429

Too Many Requests Error429_NG_AIS

500

Internal Server Error

503

Service Unavailable

Up
put /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}
Update PSU Data for payment initiation cancellation (updatePaymentCancellationPsuData)
<p>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.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>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:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
cancellationId (required)
Path Parameter — Identification for cancellation resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
Update PSU data for payment initiation (updatePaymentPsuData)
<p>This methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>There are several possible Update PSU Data requests in the context of payment initiation services needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/signing-baskets/{basketId}/authorisations/{authorisationId}
Update PSU Data for signing basket (updateSigningBasketPsuData)
<p>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.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

ConfirmationOfFundsServicePIIS

Up
post /v1/funds-confirmations
Confirmation of Funds Request (checkAvailabilityOfFunds)
Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained in the header. This field is contained but commented out in this specification.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body confirmationOfFunds (required)
Body Parameter — Request body for a confirmation of funds request.
example: { "$ref" : "#/components/examples/confirmationOfFundsExample" }

Request headers

Return type

inline_response_200_3

Example data

Content-Type: application/json
{
  "fundsAvailable" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_3

400

Bad Request Error400_NG_AIS

401

Unauthorized Error401_NG_PIIS

403

Forbidden Error403_NG_PIIS

404

Not found Error404_NG_PIIS

405

Method Not Allowed Error405_NG_PIIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

PaymentInitiationServicePIS

Up
delete /v1/{payment-service}/{payment-product}/{paymentId}
Payment Cancellation Request (cancelPayment)
<p>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.</p> <p>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).</p> <p>The response to this DELETE command will tell the TPP whether the</p> <ul> <li>access method was rejected</li> <li>access method was successful, or</li> <li>access method is generally applicable, but further authorisation processes are needed.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

paymentInitiationCancelResponse-202

Example data

Content-Type: application/json
{
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "transactionStatus" : "ACCP",
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Received paymentInitiationCancelResponse-202

204

No Content

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS_CANC

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}
Read the SCA status of the payment cancellation's authorisation. (getPaymentCancellationScaStatus)
This method returns the SCA status of a payment initiation's authorisation sub-resource.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
cancellationId (required)
Path Parameter — Identification for cancellation resource.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}
Get Payment Information (getPaymentInformation)
Returns the content of a payment object

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/authorisations
Get Payment Initiation Authorisation Sub-Resources Request (getPaymentInitiationAuthorisation)
<p>Read a list of all authorisation subresources IDs which have been created.</p> <p>This function returns an array of hyperlinks to all generated authorisation sub-resources.</p>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

authorisations

Example data

Content-Type: application/json
{
  "authorisationIds" : [ "123auth456", "123auth456" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK authorisations

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources. (getPaymentInitiationCancellationAuthorisationInformation)
Retrieve a list of all created cancellation authorisation sub-resources.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

cancellationList

Example data

Content-Type: application/json
[ "123auth456", "123auth456" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK cancellationList

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
Read the SCA Status of the payment authorisation (getPaymentInitiationScaStatus)
This method returns the SCA status of a payment initiation's authorisation sub-resource.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/{payment-service}/{payment-product}/{paymentId}/status
Payment initiation status request (getPaymentInitiationStatus)
Check the transaction status of a payment initiation.

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

paymentInitiationStatusResponse-200_json

Example data

Content-Type: application/json
{
  "transactionStatus" : "ACCP",
  "fundsAvailable" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK paymentInitiationStatusResponse-200_json

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/{payment-service}/{payment-product}
Payment initiation request (initiatePayment)
<p>This method is used to initiate a payment at the ASPSP.</p> <h2>Variants of Payment Initiation Requests</h2> <p>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.</p> <p>There are the following <strong>payment products</strong>:</p> <ul> <li>Payment products with payment information in <em>JSON</em> format: <ul> <li><strong><em>sepa-credit-transfers</em></strong></li> <li><strong><em>instant-sepa-credit-transfers</em></strong></li> <li><strong><em>target-2-payments</em></strong></li> <li><strong><em>cross-border-credit-transfers</em></strong></li> </ul> </li> <li>Payment products with payment information in <em>pain.001</em> XML format: <ul> <li><strong><em>pain.001-sepa-credit-transfers</em></strong></li> <li><strong><em>pain.001-instant-sepa-credit-transfers</em></strong></li> <li><strong><em>pain.001-target-2-payments</em></strong></li> <li><strong><em>pain.001-cross-border-credit-transfers</em></strong></li> </ul> </li> </ul> <p>Furthermore the request body depends on the <strong>payment-service</strong></p> <ul> <li> <p><strong><em>payments</em></strong>: A single payment initiation request.</p> </li> <li> <p><strong><em>bulk-payments</em></strong>: A collection of several payment iniatiation requests.</p> <p>In case of a <em>pain.001</em> message there are more than one payments contained in the *pain.001 message.</p> <p>In case of a <em>JSON</em> there are several JSON payment blocks contained in a joining list.</p> </li> <li> <p><strong><em>periodic-payments</em></strong>: 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.</p> </li> </ul> <p>This is the first step in the API to initiate the related recurring/periodic payment.</p> <h2>Single and mulitilevel SCA Processes</h2> <p>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.</p> <p>But the response messages are specific to either one SCA processing or multilevel SCA processing.</p> <p>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.</p>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — <p>JSON request body for a payment inition request message</p> <p>There are the following payment-products supported:</p> <ul> <li>&quot;sepa-credit-transfers&quot; with JSON-Body</li> <li>&quot;instant-sepa-credit-transfers&quot; with JSON-Body</li> <li>&quot;target-2-payments&quot; with JSON-Body</li> <li>&quot;cross-border-credit-transfers&quot; with JSON-Body</li> <li>&quot;pain.001-sepa-credit-transfers&quot; with XML pain.001.001.03 body for SCT scheme</li> <li>&quot;pain.001-instant-sepa-credit-transfers&quot; with XML pain.001.001.03 body for SCT INST scheme</li> <li>&quot;pain.001-target-2-payments&quot; with pain.001 body. Only country specific schemes are currently available</li> <li>&quot;pain.001-cross-border-credit-transfers&quot; with pain.001 body. Only country specific schemes are currently available</li> </ul> <p>There are the following payment-services supported:</p> <ul> <li>&quot;payments&quot;</li> <li>&quot;periodic-payments&quot;</li> <li>&quot;bulk-paments&quot;</li> </ul> <p>All optional, conditional and predefined but not yet used fields are defined.</p>
example: { "$ref" : "#/components/examples/paymentInitiationSctBody_payments_json" }

Request headers

Form parameters

xml_sct (required)
Form Parameter
json_standingorderType (required)
Form Parameter

Return type

paymentInitationRequestResponse-201

Example data

Content-Type: application/json
{
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "tppMessages" : [ {
    "path" : "path",
    "code" : "WARNING",
    "text" : "text",
    "category" : "ERROR"
  }, {
    "path" : "path",
    "code" : "WARNING",
    "text" : "text",
    "category" : "ERROR"
  } ],
  "transactionStatus" : "ACCP",
  "_links" : {
    "scaRedirect" : {
      "href" : "https://www.testbank.com/asdfasdfasdf"
    },
    "self" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "paymentId" : "1234-wertiq-983",
  "transactionFeeIndicator" : true,
  "psuMessage" : "psuMessage",
  "transactionFees" : {
    "currency" : "EUR",
    "amount" : "123"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

CREATED paymentInitationRequestResponse-201

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/{payment-service}/{payment-product}/{paymentId}/authorisations
Start the authorisation process for a payment initiation (startPaymentAuthorisation)
<p>Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations
Start the authorisation process for the cancellation of the addressed payment (startPaymentInitiationCancellationAuthorisation)
<p>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.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}
Update PSU Data for payment initiation cancellation (updatePaymentCancellationPsuData)
<p>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.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>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:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
cancellationId (required)
Path Parameter — Identification for cancellation resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
Update PSU data for payment initiation (updatePaymentPsuData)
<p>This methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>There are several possible Update PSU Data requests in the context of payment initiation services needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

payment-service (required)
Path Parameter — <p>Payment service:</p> <p>Possible values are:</p> <ul> <li>payments</li> <li>bulk-payments</li> <li>periodic-payments</li> </ul>
payment-product (required)
Path Parameter — <p>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.</p> <p>The following payment products are supported:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> <li>pain.001-sepa-credit-transfers</li> <li>pain.001-instant-sepa-credit-transfers</li> <li>pain.001-target-2-payments</li> <li>pain.001-cross-border-credit-transfers</li> </ul> <p><strong>Remark:</strong> 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.</p> <p><strong>Remark:</strong> For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.</p>
paymentId (required)
Path Parameter — Resource identification of the generated payment initiation resource.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_PIS

401

Unauthorized Error401_NG_PIS

403

Forbidden Error403_NG_PIS

404

Not found Error404_NG_PIS

405

Method Not Allowed Error405_NG_PIS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_PIS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

SigningBasketsSBS

Up
post /v1/signing-baskets
Create a signing basket resource (createSigningBasket)
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

This API call consumes the following media types via the Content-Type request header:

Request body

body signingBasket (optional)
Body Parameter — Request body for a confirmation of an establishing signing basket request
example: { "$ref" : "#/components/examples/signingBasketExample" }

Request headers

Return type

signingBasketResponse-201

Example data

Content-Type: application/json
{
  "basketId" : "1234-basket-567",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "tppMessages" : [ {
    "path" : "path",
    "code" : "WARNING",
    "text" : "text",
    "category" : "ERROR"
  }, {
    "path" : "path",
    "code" : "WARNING",
    "text" : "text",
    "category" : "ERROR"
  } ],
  "transactionStatus" : "RCVD",
  "_links" : {
    "scaRedirect" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created signingBasketResponse-201

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
delete /v1/signing-baskets/{basketId}
Delete the signing basket (deleteSigningBasket)
<p>Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.</p> <p>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.</p>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}
Returns the content of an signing basket object. (getSigningBasket)
Returns the content of an signing basket object.

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Return type

signingBasketResponse-200

Example data

Content-Type: application/json
{
  "transactionStatus" : "RCVD",
  "_links" : {
    "scaRedirect" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "payments" : [ "1234-wertiq-983", "1234-wertiq-983" ],
  "consents" : [ "consents", "consents" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK signingBasketResponse-200

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/authorisations
Get Signing Basket Authorisation Sub-Resources Request (getSigningBasketAuthorisation)
<p>Read a list of all authorisation subresources IDs which have been created.</p> <p>This function returns an array of hyperlinks to all generated authorisation sub-resources.</p>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Return type

authorisations

Example data

Content-Type: application/json
{
  "authorisationIds" : [ "123auth456", "123auth456" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK authorisations

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/authorisations/{authorisationId}
Read the SCA status of the signing basket authorisation (getSigningBasketScaStatus)
This method returns the SCA status of a signing basket's authorisation sub-resource.

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Request headers

Return type

scaStatusResponse

Example data

Content-Type: application/json
{
  "scaStatus" : "psuAuthenticated"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK scaStatusResponse

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
get /v1/signing-baskets/{basketId}/status
Read the status of the signing basket (getSigningBasketStatus)
Returns the status of a signing basket object.

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Request headers

Return type

signingBasketStatusResponse-200

Example data

Content-Type: application/json
{
  "transactionStatus" : "RCVD"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK signingBasketStatusResponse-200

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
post /v1/signing-baskets/{basketId}/authorisations
Start the authorisation process for a signing basket (startSigningBasketAuthorisation)
<p>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.</p> <p>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.</p> <p>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.</p> <p>The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.</p> <p>This applies in the following scenarios:</p> <ul> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms. <ul> <li>'startAuthorisationWithPsuIdentfication',</li> <li>'startAuthorisationWithPsuAuthentication'</li> <li>'startAuthorisationWithEncryptedPsuAuthentication'</li> <li>'startAuthorisationWithAuthentciationMethodSelection'</li> </ul> </li> <li>The related payment initiation cannot yet be executed since a multilevel SCA is mandated.</li> <li>The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.</li> <li>The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.</li> <li>The signing basket needs to be authorised yet.</li> </ul>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter

Request headers

Return type

startScaprocessResponse

Example data

Content-Type: application/json
{
  "authorisationId" : "123auth456",
  "scaStatus" : "psuAuthenticated",
  "scaMethods" : [ {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  }, {
    "authenticationVersion" : "authenticationVersion",
    "name" : "SMS OTP on phone +49160 xxxxx 28",
    "authenticationType" : "SMS_OTP",
    "explanation" : "Detailed information about the SCA method for the PSU.",
    "authenticationMethodId" : "myAuthenticationID"
  } ],
  "challengeData" : {
    "otpMaxLength" : 0,
    "image" : "",
    "imageLink" : "http://example.com/aeiou",
    "otpFormat" : "characters",
    "additionalInformation" : "additionalInformation",
    "data" : [ "data", "data" ]
  },
  "_links" : {
    "key" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  },
  "psuMessage" : "psuMessage"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created startScaprocessResponse

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Up
put /v1/signing-baskets/{basketId}/authorisations/{authorisationId}
Update PSU Data for signing basket (updateSigningBasketPsuData)
<p>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.</p> <p>Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.</p> <p>This methods updates PSU data on the cancellation authorisation resource if needed.</p> <p>There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:</p> <ul> <li>Redirect SCA Approach: A specific Update PSU Data Request is applicable for <ul> <li>the selection of authentication methods, before choosing the actual SCA approach.</li> </ul> </li> <li>Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for <ul> <li>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</li> <li>the selection of authentication methods.</li> </ul> </li> <li>Embedded SCA Approach: The Update PSU Data Request might be used <ul> <li>to add credentials as a first factor authentication data of the PSU and</li> <li>to select the authentication method and</li> <li>transaction authorisation.</li> </ul> </li> </ul> <p>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:</p> <ul> <li>Select an SCA method in case of several SCA methods are available for the customer.</li> </ul> <p>There are the following request types on this access path:</p> <ul> <li>Update PSU Identification</li> <li>Update PSU Authentication</li> <li>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.</li> <li>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.</li> </ul>

Path parameters

basketId (required)
Path Parameter — This identification of the corresponding signing basket object.
authorisationId (required)
Path Parameter — Resource identification of the related SCA.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter
example: { "value" : { } }

Request headers

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Bad Request Error400_NG_SBS

401

Unauthorized Error401_NG_SBS

403

Forbidden Error403_NG_SBS

404

Not found Error404_NG_SBS

405

Method Not Allowed Error405_NG_SBS

406

Not Acceptable

408

Request Timeout

409

Conflict Error409_NG_SBS

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Models

[ Jump to Methods ]

Table of Contents

  1. Error400_AIS
  2. Error400_AIS_additionalErrors
  3. Error400_NG_AIS
  4. Error400_NG_PIIS
  5. Error400_NG_PIS
  6. Error400_NG_SBS
  7. Error400_PIIS
  8. Error400_PIIS_additionalErrors
  9. Error400_PIS
  10. Error400_PIS_additionalErrors
  11. Error400_SBS
  12. Error400_SBS_additionalErrors
  13. Error401_AIS
  14. Error401_AIS_additionalErrors
  15. Error401_NG_AIS
  16. Error401_NG_PIIS
  17. Error401_NG_PIS
  18. Error401_NG_SBS
  19. Error401_PIIS
  20. Error401_PIIS_additionalErrors
  21. Error401_PIS
  22. Error401_PIS_additionalErrors
  23. Error401_SBS
  24. Error401_SBS_additionalErrors
  25. Error403_AIS
  26. Error403_AIS_additionalErrors
  27. Error403_NG_AIS
  28. Error403_NG_PIIS
  29. Error403_NG_PIS
  30. Error403_NG_SBS
  31. Error403_PIIS
  32. Error403_PIIS_additionalErrors
  33. Error403_PIS
  34. Error403_PIS_additionalErrors
  35. Error403_SBS
  36. Error403_SBS_additionalErrors
  37. Error404_AIS
  38. Error404_AIS_additionalErrors
  39. Error404_NG_AIS
  40. Error404_NG_PIIS
  41. Error404_NG_PIS
  42. Error404_NG_SBS
  43. Error404_PIIS
  44. Error404_PIIS_additionalErrors
  45. Error404_PIS
  46. Error404_PIS_additionalErrors
  47. Error404_SBS
  48. Error404_SBS_additionalErrors
  49. Error405_AIS
  50. Error405_AIS_additionalErrors
  51. Error405_NG_AIS
  52. Error405_NG_PIIS
  53. Error405_NG_PIS
  54. Error405_NG_PIS_CANC
  55. Error405_NG_SBS
  56. Error405_PIIS
  57. Error405_PIIS_additionalErrors
  58. Error405_PIS
  59. Error405_PIS_CANC
  60. Error405_PIS_CANC_additionalErrors
  61. Error405_PIS_additionalErrors
  62. Error405_SBS
  63. Error405_SBS_additionalErrors
  64. Error406_AIS
  65. Error406_AIS_additionalErrors
  66. Error406_NG_AIS
  67. Error409_AIS
  68. Error409_AIS_additionalErrors
  69. Error409_NG_AIS
  70. Error409_NG_PIIS
  71. Error409_NG_PIS
  72. Error409_NG_SBS
  73. Error409_PIIS
  74. Error409_PIIS_additionalErrors
  75. Error409_PIS
  76. Error409_PIS_additionalErrors
  77. Error409_SBS
  78. Error409_SBS_additionalErrors
  79. Error429_AIS
  80. Error429_AIS_additionalErrors
  81. Error429_NG_AIS
  82. MessageCode2XX
  83. MessageCode400_AIS
  84. MessageCode400_PIIS
  85. MessageCode400_PIS
  86. MessageCode400_SBS
  87. MessageCode401_AIS
  88. MessageCode401_PIIS
  89. MessageCode401_PIS
  90. MessageCode401_SBS
  91. MessageCode403_AIS
  92. MessageCode403_PIIS
  93. MessageCode403_PIS
  94. MessageCode403_SBS
  95. MessageCode404_AIS
  96. MessageCode404_PIIS
  97. MessageCode404_PIS
  98. MessageCode404_SBS
  99. MessageCode405_AIS
  100. MessageCode405_PIIS
  101. MessageCode405_PIS
  102. MessageCode405_PIS_CANC
  103. MessageCode405_SBS
  104. MessageCode406_AIS
  105. MessageCode409_AIS
  106. MessageCode409_PIIS
  107. MessageCode409_PIS
  108. MessageCode409_SBS
  109. MessageCode429_AIS
  110. OneOfperiodicPaymentInitiationMultipartBodyxml_sct
  111. _linksAccountDetails
  112. _linksAccountReport
  113. _linksAll
  114. _linksCardAccountReport
  115. _linksConsents
  116. _linksDownload
  117. _linksGetConsent
  118. _linksPaymentInitiation
  119. _linksPaymentInitiationCancel
  120. _linksSelectPsuAuthenticationMethod
  121. _linksSigningBasket
  122. _linksStartScaProcess
  123. _linksTransactionDetails
  124. _linksUpdatePsuAuthentication
  125. _linksUpdatePsuIdentification
  126. accountAccess
  127. accountDetails
  128. accountId
  129. accountList
  130. accountReference
  131. accountReport
  132. accountStatus
  133. address
  134. amount
  135. amountValue
  136. authenticationMethodId
  137. authenticationObject
  138. authenticationType
  139. authorisationId
  140. authorisations
  141. authorisationsList
  142. authorization
  143. balance
  144. balanceList
  145. balanceType
  146. bankTransactionCode
  147. basketId
  148. batchBookingPreferred
  149. bban
  150. bicfi
  151. bookingDate
  152. bulkPaymentInitiationWithStatusResponse
  153. bulkPaymentInitiation_json
  154. camt.052
  155. camt.053
  156. camt.054
  157. cancellationId
  158. cancellationList
  159. cardAccountDetails
  160. cardAccountList
  161. cardAccountReport
  162. cardAccountsTransactionsResponse200
  163. cardTransaction
  164. cardTransactionId
  165. cardTransactionList
  166. cashAccountType
  167. challengeData
  168. chargeBearer
  169. chosenScaMethod
  170. combinedServiceIndicator
  171. confirmationOfFunds
  172. consentId
  173. consentIdList
  174. consentInformationResponse-200_json
  175. consentStatus
  176. consentStatusResponse-200
  177. consents
  178. consentsResponse-201
  179. countryCode
  180. creditorAgentName
  181. creditorName
  182. creditorNameAndAddress
  183. currencyCode
  184. dayOfExecution
  185. debtorId
  186. debtorName
  187. endDate
  188. entryReference
  189. executionRule
  190. frequencyCode
  191. frequencyPerDay
  192. fundsAvailable
  193. hrefEntry
  194. hrefType
  195. iban
  196. inline_response_200
  197. inline_response_200_1
  198. inline_response_200_2
  199. inline_response_200_3
  200. lastActionDate
  201. maskedPan
  202. merchantCategoryCode
  203. msisdn
  204. mt940
  205. mt942
  206. pan
  207. paymentExchangeRate
  208. paymentId
  209. paymentIdList
  210. paymentInitationRequestResponse-201
  211. paymentInitiationBulkElement_json
  212. paymentInitiationCancelResponse-202
  213. paymentInitiationCrossBorder_pain.001
  214. paymentInitiationSctInst_pain.001
  215. paymentInitiationSct_pain.001
  216. paymentInitiationStatusResponse-200_json
  217. paymentInitiationStatusResponse-200_xml
  218. paymentInitiationTarget2_pain.001
  219. paymentInitiationWithStatusResponse
  220. paymentInitiation_json
  221. periodicPaymentInitiationMultipartBody
  222. periodicPaymentInitiationWithStatusResponse
  223. periodicPaymentInitiation_json
  224. periodicPaymentInitiation_xml-Part2-standingorderType_json
  225. proprietaryBankTransactionCode
  226. psuData
  227. psuMessageText
  228. purposeCode
  229. readAccountBalanceResponse-200
  230. readCardAccountBalanceResponse-200
  231. recurringIndicator
  232. remittanceInformationStructured
  233. remittanceInformationUnstructured
  234. remittanceInformationUnstructuredArray
  235. reportExchangeRate
  236. reportExchangeRateList
  237. scaAuthenticationData
  238. scaMethods
  239. scaStatus
  240. scaStatusResponse
  241. selectPsuAuthenticationMethod
  242. selectPsuAuthenticationMethodResponse
  243. signingBasket
  244. signingBasketResponse-200
  245. signingBasketResponse-201
  246. signingBasketStatusResponse-200
  247. startDate
  248. startScaprocessResponse
  249. terminalId
  250. tppErrorDetail
  251. tppErrorTitle
  252. tppMessage2XX
  253. tppMessage400_AIS
  254. tppMessage400_PIIS
  255. tppMessage400_PIS
  256. tppMessage400_SBS
  257. tppMessage401_AIS
  258. tppMessage401_PIIS
  259. tppMessage401_PIS
  260. tppMessage401_SBS
  261. tppMessage403_AIS
  262. tppMessage403_PIIS
  263. tppMessage403_PIS
  264. tppMessage403_SBS
  265. tppMessage404_AIS
  266. tppMessage404_PIIS
  267. tppMessage404_PIS
  268. tppMessage404_SBS
  269. tppMessage405_AIS
  270. tppMessage405_PIIS
  271. tppMessage405_PIS
  272. tppMessage405_PIS_CANC
  273. tppMessage405_SBS
  274. tppMessage406_AIS
  275. tppMessage409_AIS
  276. tppMessage409_PIIS
  277. tppMessage409_PIS
  278. tppMessage409_SBS
  279. tppMessage429_AIS
  280. tppMessageCategory
  281. tppMessageText
  282. transactionAuthorisation
  283. transactionDate
  284. transactionDetails
  285. transactionFeeIndicator
  286. transactionId
  287. transactionList
  288. transactionStatus
  289. transactionStatus_SBS
  290. transactionsResponse-200_json
  291. ultimateCreditor
  292. ultimateDebtor
  293. updatePsuAuthentication
  294. updatePsuAuthenticationResponse
  295. updatePsuIdenticationResponse
  296. validUntil

Error400_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error400_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error400_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error400_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
tppMessages (optional)
_links (optional)

Error400_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
tppMessages (optional)
_links (optional)

Error400_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
tppMessages (optional)
_links (optional)

Error400_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
tppMessages (optional)
_links (optional)

Error400_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error400_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error400_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error400_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error400_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error400_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error400_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error400_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error400_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error401_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error401_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error401_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error401_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error401_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error401_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error401_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error401_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error401_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error401_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error401_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error401_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error401_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error401_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error401_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error401_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error403_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error403_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error403_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error403_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
tppMessages (optional)
_links (optional)

Error403_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
tppMessages (optional)
_links (optional)

Error403_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
tppMessages (optional)
_links (optional)

Error403_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
tppMessages (optional)
_links (optional)

Error403_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error403_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error403_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error403_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error403_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error403_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error403_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error403_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error403_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error404_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error404_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error404_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error404_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
tppMessages (optional)
_links (optional)

Error404_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
tppMessages (optional)
_links (optional)

Error404_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
tppMessages (optional)
_links (optional)

Error404_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
tppMessages (optional)
_links (optional)

Error404_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error404_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error404_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error404_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error404_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error404_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error404_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error404_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error404_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error405_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error405_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error405_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error405_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error405_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error405_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error405_NG_PIS_CANC Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error405_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
tppMessages (optional)
_links (optional)

Error405_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error405_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error405_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error405_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error405_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error405_PIS_CANC Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for a pament cancelation (PIS).
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error405_PIS_CANC_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error405_PIS_CANC_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error405_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error405_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error405_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error405_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error406_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 406 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error406_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error406_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error406_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.
tppMessages (optional)
_links (optional)

Error409_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error409_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error409_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error409_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
tppMessages (optional)
_links (optional)

Error409_NG_PIIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
tppMessages (optional)
_links (optional)

Error409_NG_PIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
tppMessages (optional)
_links (optional)

Error409_NG_SBS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
tppMessages (optional)
_links (optional)

Error409_PIIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error409_PIIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error409_PIIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error409_PIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error409_PIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error409_PIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error409_SBS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for signing baskets.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error409_SBS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error409_SBS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807].
title (optional)
detail (optional)
code

Error429_AIS Up

Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 429 for AIS.
type
String A URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future. format: uri
title (optional)
String Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
detail (optional)
String Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
code
additionalErrors (optional)
array[Error429_AIS_additionalErrors] <p>Array of Error Information Blocks.</p> <p>Might be used if more than one error is to be communicated</p>
_links (optional)

Error429_AIS_additionalErrors Up

This is a data element to support the declaration of additional errors in the context of [RFC7807] in case of a HTTP error code 429 for.
title (optional)
detail (optional)
code

Error429_NG_AIS Up

NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.
tppMessages (optional)
_links (optional)

MessageCode2XX Up

Message codes for HTTP Error codes 2XX.

MessageCode400_AIS Up

Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).

MessageCode400_PIIS Up

Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).

MessageCode400_PIS Up

Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).

MessageCode400_SBS Up

Message codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).

MessageCode401_AIS Up

Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).

MessageCode401_PIIS Up

Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).

MessageCode401_PIS Up

Message codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).

MessageCode401_SBS Up

Message codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).

MessageCode403_AIS Up

Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).

MessageCode403_PIIS Up

Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).

MessageCode403_PIS Up

Message codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).

MessageCode403_SBS Up

Message codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).

MessageCode404_AIS Up

Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).

MessageCode404_PIIS Up

Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).

MessageCode404_PIS Up

Message codes defined for PIS for HTTP Error code 404 (NOT FOUND).

MessageCode404_SBS Up

Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).

MessageCode405_AIS Up

Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).

MessageCode405_PIIS Up

Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).

MessageCode405_PIS Up

Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).

MessageCode405_PIS_CANC Up

Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).

MessageCode405_SBS Up

Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).

MessageCode406_AIS Up

Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).

MessageCode409_AIS Up

Message codes defined for AIS for HTTP Error code 409 (CONFLICT).

MessageCode409_PIIS Up

Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).

MessageCode409_PIS Up

Message codes defined for PIS for HTTP Error code 409 (CONFLICT).

MessageCode409_SBS Up

Message codes defined for signing baskets for HTTP Error code 409 (CONFLICT).

MessageCode429_AIS Up

Message codes for HTTP Error code 429 (TOO MANY REQUESTS).

OneOfperiodicPaymentInitiationMultipartBodyxml_sct Up

_linksAccountDetails Up

<p>Links to the account, which can be directly used for retrieving account information from this dedicated account.</p> <p>Links to &quot;balances&quot; and/or &quot;transactions&quot;</p> <p>These links are only supported, when the corresponding consent has been already granted.</p>

_linksAccountReport Up

_linksAll Up

A _link object with all availabel link types

_linksCardAccountReport Up

_linksConsents Up

<p>A list of hyperlinks to be recognised by the TPP.</p> <p>Type of links admitted in this response (which might be extended by single ASPSPs as indicated in its XS2A documentation):</p> <ul> <li>'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.</li> <li>'scaOAuth': In case of an OAuth2 based Redirect Approach, the ASPSP is transmitting the link where the configuration of the OAuth2 Server is defined. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.</li> <li>'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).</li> <li>'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.</li> <li>'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.</li> </ul> <ul> <li>'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.</li> </ul> <ul> <li>'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'</li> <li>'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.</li> <li>'self': The link to the Establish Account Information Consent resource created by this request. This link can be used to retrieve the resource data.</li> <li>'status': The link to retrieve the status of the account information consent.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.</li> </ul>

_linksDownload Up

<p>A list of hyperlinks to be recognised by the TPP.</p> <p>Type of links admitted in this response:</p> <ul> <li>&quot;download&quot;: a link to a resource, where the transaction report might be downloaded from in case where transaction reports have a huge size.</li> </ul> <p>Remark: This feature shall only be used where camt-data is requested which has a huge size.</p>

_linksGetConsent Up

<p>A list of hyperlinks to be recognised by the TPP.</p> <p>Links of type &quot;account&quot; and/or &quot;cardAccount&quot;, depending on the nature of the consent.</p>

_linksPaymentInitiation Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p><strong>Remark:</strong> All links can be relative or full links, to be decided by the ASPSP.</p> <p>Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.</li> <li>'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.</li> <li>'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).</li> <li>'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.</li> <li>'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data. <ul> <li>'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.</li> </ul> </li> <li>'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element &quot;scaMethods&quot;</li> <li>'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.</li> <li>'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.</li> <li>'status': The link to retrieve the transaction status of the payment initiation.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.</li> </ul>

_linksPaymentInitiationCancel Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p>Remark: All links can be relative or full links, to be decided by the ASPSP.</p> <p>Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'startAuthorisation': In case, where just the authorisation process of the cancellation needs to be started, but no additional data needs to be updated for time being (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).</li> <li>'startAuthorisationWithPsuIdentification': In case where a PSU Identification needs to be updated when starting the cancellation authorisation: The link to the cancellation-authorisations end-point, where the cancellation sub-resource has to be generated while uploading the PSU identification data.</li> <li>'startAuthorisationWithPsuAuthentication': In case of a yet to be created authorisation sub-resource: The link to the cancalation authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.</li> <li>'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.</li> <li>'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the cancellation-authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'</li> </ul>

_linksSelectPsuAuthenticationMethod Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p><strong>Remark:</strong> All links can be relative or full links, to be decided by the ASPSP.</p> <p><strong>Remark:</strong> This method can be applied before or after PSU identification. This leads to many possible hyperlink responses. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.</li> <li>'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.</li> <li>'updatePsuIdentification': The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.</li> <li>'updatePsuAuthentication': The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded. <ul> <li>'updateEncryptedPsuAuthentication': The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication encrypted data needs to be uploaded.</li> </ul> </li> <li>'updateAdditionalPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional PSU password.</li> <li>'updateAdditionalEncryptedPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional encrypted PSU password.</li> <li>'authoriseTransaction': The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.</li> </ul>

_linksSigningBasket Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p>Remark: All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.</li> <li>'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.</li> <li>'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).</li> <li>'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.</li> <li>'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.</li> <li>'startAuthorisationWithEncryptedPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the encrypted PSU authentication data.</li> <li>'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'</li> <li>'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.</li> <li>'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.</li> <li>'status': The link to retrieve the transaction status of the payment initiation.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.</li> </ul>
scaRedirect (optional)
scaOAuth (optional)
startAuthorisation (optional)
startAuthorisationWithPsuIdentification (optional)
startAuthorisationWithPsuAuthentication (optional)
startAuthorisationWithEncryptedPsuAuthentication (optional)
startAuthorisationWithAuthenticationMethodSelection (optional)
startAuthorisationWithTransactionAuthorisation (optional)
self (optional)
status (optional)
scaStatus (optional)

_linksStartScaProcess Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p><strong>Remark:</strong> All links can be relative or full links, to be decided by the ASPSP.</p> <p>Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.</li> <li>'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.</li> <li>'updatePsuIdentification': The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.</li> <li>'startAuthorisationWithPsuAuthentication': The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded.</li> <li>'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.</li> <li>'selectAuthenticationMethod': The link to the authorisation or cancellation authorisation sub-resource, where the selected authentication method needs to be uploaded. This link is contained under exactly the same conditions as the data element 'scaMethods'.</li> <li>'authoriseTransaction': The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.</li> </ul>

_linksTransactionDetails Up

_linksUpdatePsuAuthentication Up

<p>A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU. Type of links admitted in this response:</p> <ul> <li>'updateAdditionalPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional PSU password. This link is only contained in rare cases, where such additional passwords are needed for PSU authentications.</li> <li>'updateAdditionalEncryptedPsuAuthentication': The link to the payment initiation or account information resource, which needs to be updated by an additional encrypted PSU password. This link is only contained in rare cases, where such additional passwords are needed for PSU authentications.</li> <li>'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. This link is only contained, if the PSU is already identified or authenticated with the first relevant factor or alternatively an access token, if SCA is required and if the PSU has a choice between different authentication methods. If this link is contained, then there is also the data element 'scaMethods' contained in the response body.</li> <li>'authoriseTransaction': The link to the resource, where the &quot;Transaction Authorisation Request&quot; is sent to. This is the link to the resource which will authorise the transaction by checking the SCA authentication data within the Embedded SCA approach.</li> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.</li> </ul>

_linksUpdatePsuIdentification Up

<p>A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.</p> <p><strong>Remark:</strong> All links can be relative or full links, to be decided by the ASPSP.</p> <p>Type of links admitted in this response, (further links might be added for ASPSP defined extensions):</p> <ul> <li>'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.</li> <li>'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there are several available authentication methods and if the PSU is already sufficiently authenticated.. If this link is contained, then there is also the data element &quot;scaMethods&quot; contained in the response body</li> </ul>

accountAccess Up

Requested access services for a consent.
accounts (optional)
array[accountReference] <p>Is asking for detailed account information.</p> <p>If the array is empty, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for balances or transactions shall be empty, if used.</p>
balances (optional)
array[accountReference] <p>Is asking for balances of the addressed accounts.</p> <p>If the array is empty, the TPP is asking for the balances of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts or transactions shall be empty, if used.</p>
transactions (optional)
array[accountReference] <p>Is asking for transactions of the addressed accounts.</p> <p>If the array is empty, the TPP is asking for the transactions of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts or balances shall be empty, if used.</p>
availableAccounts (optional)
String <p>Optional if supported by API provider.</p> <p>Only the value &quot;allAccounts&quot; is admitted.</p>
Enum:
allAccounts
availableAccountsWithBalance (optional)
String <p>Optional if supported by API provider.</p> <p>Only the value &quot;allAccounts&quot; is admitted.</p>
Enum:
allAccounts
allPsd2 (optional)
String <p>Optional if supported by API provider.</p> <p>Only the value &quot;allAccounts&quot; is admitted.</p>
Enum:
allAccounts

accountDetails Up

<p>The ASPSP shall give at least one of the account reference identifiers:</p> <ul> <li>iban</li> <li>bban</li> <li>pan</li> <li>maskedPan</li> <li>msisdn If the account is a multicurrency account currency code in &quot;currency&quot; is set to &quot;XXX&quot;.</li> </ul>
resourceId (optional)
String This shall be filled, if addressable resource are created by the ASPSP on the /accounts or /card-accounts endpoint.
iban (optional)
bban (optional)
msisdn (optional)
currency
name (optional)
String Name of the account given by the bank or the PSU in online-banking.
product (optional)
String Product name of the bank for this account, proprietary definition.
cashAccountType (optional)
status (optional)
bic (optional)
linkedAccounts (optional)
String Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usage (optional)
String <p>Specifies the usage of the account</p> <ul> <li>PRIV: private personal account</li> <li>ORGA: professional account</li> </ul>
Enum:
PRIV
ORGA
details (optional)
String <p>Specifications that might be provided by the ASPSP</p> <ul> <li>characteristics of the account</li> <li>characteristics of the relevant card</li> </ul>
balances (optional)
_links (optional)

accountId Up

This identification is denoting the addressed account, where the transaction has been performed.

accountList Up

List of accounts with details.
accounts

accountReference Up

<p>Reference to an account by either</p> <ul> <li>IBAN, of a payment accounts, or</li> <li>BBAN, for payment accounts if there is no IBAN, or</li> <li>the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or</li> <li>the Primary Account Number (PAN) of a card in a masked form, or</li> <li>an alias to access a payment account via a registered mobile phone number (MSISDN).</li> </ul>
iban (optional)
bban (optional)
pan (optional)
maskedPan (optional)
msisdn (optional)
currency (optional)

accountReport Up

<p>JSON based account report. This account report contains transactions resulting from the query parameters.</p> <p>'booked' shall be contained if bookingStatus parameter is set to &quot;booked&quot; or &quot;both&quot;.</p> <p>'pending' is not contained if the bookingStatus parameter is set to &quot;booked&quot;.</p>
booked (optional)
pending (optional)
_links

accountStatus Up

<p>Account status. The value is one of the following:</p> <ul> <li>&quot;enabled&quot;: account is available</li> <li>&quot;deleted&quot;: account is terminated</li> <li>&quot;blocked&quot;: account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.</li> </ul>

address Up

streetName (optional)
buildingNumber (optional)
townName (optional)
postCode (optional)
country

amount Up

currency
amount

amountValue Up

<p>The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.</p> <p><strong>Example:</strong> Valid representations for EUR with up to two decimals are:</p> <ul> <li>1056</li> <li>5768.2</li> <li>-1.50</li> <li>5877.78</li> </ul>

authenticationMethodId Up

An identification provided by the ASPSP for the later identification of the authentication method selection.

authenticationObject Up

Authentication Object
authenticationType
authenticationVersion (optional)
String Depending on the &quot;authenticationType&quot;. This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation.
authenticationMethodId
name (optional)
String This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like &quot;SMS OTP on phone +49160 xxxxx 28&quot;. This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
example: SMS OTP on phone +49160 xxxxx 28
explanation (optional)
String Detailed information about the SCA method for the PSU.
example: Detailed information about the SCA method for the PSU.

authenticationType Up

<p>Type of the authentication method.</p> <p>More authentication types might be added during implementation projects and documented in the ASPSP documentation.</p> <ul> <li>'SMS_OTP': An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.</li> <li>'CHIP_OTP': An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU.</li> <li>'PHOTO_OTP': An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU.</li> <li>'PUSH_OTP': An OTP is pushed to a dedicated authentication APP and displayed to the PSU.</li> </ul>

authorisationId Up

Resource identification of the related SCA

authorisations Up

An array of all authorisationIds
authorisationIds

authorisationsList Up

An array of all authorisationIds

authorization Up

Authorization by OAuth2 based Protocol.

balance Up

A single balance element
balanceAmount
balanceType
creditLimitIncluded (optional)
Boolean A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
example: false
lastChangeDateTime (optional)
Date This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. format: date-time
referenceDate (optional)
date Reference date of the balance format: date
lastCommittedTransaction (optional)
String &quot;entryReference&quot; of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.

balanceList Up

A list of balances regarding this account, e.g. the current balance, the last booked balance. The list migght be restricted to the current ballance.

balanceType Up

<p>The following balance types are defined:</p> <ul> <li> <p>&quot;closingBooked&quot;: Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.</p> <p>For card-accounts, this is composed of</p> <ul> <li>invoiced, but not yet paid entries</li> </ul> </li> <li> <p>&quot;expected&quot;: Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.</p> <p>For card accounts, this is composed of</p> <ul> <li>invoiced, but not yet paid entries,</li> <li>not yet invoiced but already booked entries and</li> <li>pending items (not yet booked)</li> </ul> </li> <li> <p>&quot;authorised&quot;: The expected balance together with the value of a pre-approved credit line the ASPSP makes permanently available to the user.</p> <p>For card-accounts:</p> <p>&quot;money to spend with the value of a pre-approved credit limit on the card account&quot;</p> </li> <li> <p>&quot;openingBooked&quot;: Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.</p> </li> <li> <p>&quot;interimAvailable&quot;: Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.</p> <p>For card-accounts, this is composed of</p> <ul> <li>invoiced, but not yet paid entries,</li> <li>not yet invoiced but already booked entries</li> </ul> </li> <li> <p>&quot;interimBooked&quot;: Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.</p> </li> <li> <p>&quot;forwardAvailable&quot;: Forward available balance of money that is at the disposal of the account owner on the date specified.</p> </li> <li> <p>&quot;nonInvoiced&quot;: Only for card accounts, to be checked yet.</p> </li> </ul>

bankTransactionCode Up

<p>Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.</p> <p>This code type is concatenating the three ISO20022 Codes</p> <ul> <li>Domain Code,</li> <li>Family Code, and</li> <li>SubFamiliy Code by hyphens, resulting in �DomainCode�-�FamilyCode�-�SubFamilyCode�.</li> </ul>

basketId Up

Resource identification of the generated signing basket resource.

batchBookingPreferred Up

<p>If this element equals 'true', the PSU prefers only one booking entry. If this element equals 'false', the PSU prefers individual booking of all contained individual transactions.</p> <p>The ASPSP will follow this preference according to contracts agreed on with the PSU.</p>

bban Up

<p>Basic Bank Account Number (BBAN) Identifier</p> <p>This data element can be used in the body of the Consent Request Message for retrieving Account access Consent from this Account. This data elements is used for payment Accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).</p> <p>Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.</p>

bicfi Up

BICFI

bookingDate Up

The Date when an entry is posted to an account on the ASPSPs books.

bulkPaymentInitiationWithStatusResponse Up

Generic JSON response body consistion of the corresponding bulk payment initation JSON body together with an optional transaction status field.
batchBookingPreferred (optional)
requestedExecutionDate (optional)
date format: date
debtorAccount
payments
array[paymentInitiationBulkElement_json] <p>A list of generic JSON bodies payment initations for bulk payments via JSON.</p> <p>Note: Some fields from single payments do not occcur in a bulk payment element</p>
transactionStatus (optional)

bulkPaymentInitiation_json Up

<p>Generic Body for a bulk payment initation via JSON.</p> <p>paymentInformationId is contained in code but commented since it is n.a. and not all ASPSP are able to support this field now. In a later version the field will be mandatory.</p>
batchBookingPreferred (optional)
debtorAccount
requestedExecutionDate (optional)
date format: date
requestedExecutionTime (optional)
Date format: date-time
payments
array[paymentInitiationBulkElement_json] <p>A list of generic JSON bodies payment initations for bulk payments via JSON.</p> <p>Note: Some fields from single payments do not occcur in a bulk payment element</p>

camt.052 Up

camt.052 XML message

camt.053 Up

camt.053 XML message

camt.054 Up

camt.054 XML message

cancellationId Up

Identification for cancellation resource

cancellationList Up

An array of all cancellationIds connected to this resource.

cardAccountDetails Up

Card account details
resourceId (optional)
String This is the data element to be used in the path when retrieving data from a dedicated account. This shall be filled, if addressable resource are created by the ASPSP on the /card-accounts endpoint.
maskedPan
currency
name (optional)
String Name of the account given by the bank or the PSU in online-banking.
product (optional)
String Product name of the bank for this account, proprietary definition.
status (optional)
usage (optional)
String <p>Specifies the usage of the account</p> <ul> <li>PRIV: private personal account</li> <li>ORGA: professional account</li> </ul>
Enum:
PRIV
ORGA
details (optional)
String <p>Specifications that might be provided by the ASPSP</p> <ul> <li>characteristics of the account</li> <li>characteristics of the relevant card</li> </ul>
creditLimit (optional)
balances (optional)
_links (optional)

cardAccountList Up

List of card accounts with details.
cardAccounts

cardAccountReport Up

<p>JSON based card account report.</p> <p>This card account report contains transactions resulting from the query parameters.</p>
booked
pending (optional)
_links

cardAccountsTransactionsResponse200 Up

Body of the JSON response for a successful read card account transaction list request. This card account report contains transactions resulting from the query parameters.
cardAccount (optional)
cardTransactions (optional)
balances (optional)
_links (optional)

cardTransaction Up

Card transaction information
cardTransactionId (optional)
terminalId (optional)
transactionDate (optional)
bookingDate (optional)
transactionAmount
currencyExchange (optional)
originalAmount (optional)
markupFee (optional)
markupFeePercentage (optional)
example: 0.3
cardAcceptorId (optional)
cardAcceptorAddress (optional)
merchantCategoryCode (optional)
maskedPAN (optional)
transactionDetails (optional)
invoiced (optional)
proprietaryBankTransactionCode (optional)

cardTransactionId Up

Unique end to end identity.

cardTransactionList Up

Array of transaction details

cashAccountType Up

ExternalCashAccountType1Code from ISO 20022.

challengeData Up

It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
image (optional)
byte[] PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method. format: byte
data (optional)
array[String] A collection of strings as challenge data
imageLink (optional)
String A link where the ASPSP will provides the challenge image for the TPP. format: url
otpMaxLength (optional)
Integer The maximal length for the OTP to be typed in by the PSU.
otpFormat (optional)
String The format type of the OTP to be typed in. The admitted values are &quot;characters&quot; or &quot;integer&quot;.
Enum:
characters
integer
additionalInformation (optional)
String Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU.

chargeBearer Up

Charge Bearer. ChargeBearerType1Code from ISO20022

chosenScaMethod Up

combinedServiceIndicator Up

If &quot;true&quot; indicates that a payment initiation service will be addressed in the same &quot;session&quot;.

confirmationOfFunds Up

<p>JSON Request body for the &quot;Confirmation of Funds Service&quot;</p> <table> <tr> <td>cardNumber</td> <td>String </td> <td>Optional</td> <td>Card Number of the card issued by the PIISP. Should be delivered if available.</td> </tr> <tr> <td>account</td> <td> Account Reference</td> <td>Mandatory</td> <td>PSU's account number.</td> </tr> <tr> <td>payee</td> <td>Max70Text</td> <td>Optional</td> <td>The merchant where the card is accepted as an information to the PSU.</td> </tr> <tr> <td>instructedAmount</td> <td>Amount</td> <td>Mandatory</td> <td>Transaction amount to be checked within the funds check mechanism.</td> </tr> </table>
cardNumber (optional)
String Card Number of the card issued by the PIISP. Should be delivered if available.
account
payee (optional)
String Name payee
instructedAmount

consentId Up

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

consentIdList Up

A list of consentIds

consentInformationResponse-200_json Up

Body of the JSON response for a successfull get consent request.
access
recurringIndicator
validUntil
frequencyPerDay
lastActionDate
consentStatus
_links (optional)

consentStatus Up

<p>This is the overall lifecycle status of the consent.</p> <p>Valid values are:</p> <ul> <li>'received': The consent data have been received and are technically correct. The data is not authorised yet.</li> <li>'rejected': The consent data have been rejected e.g. since no successful authorisation has taken place.</li> <li>'valid': The consent is accepted and valid for GET account data calls and others as specified in the consent object.</li> <li>'revokedByPsu': The consent has been revoked by the PSU towards the ASPSP.</li> <li>'expired': The consent expired.</li> <li>'terminatedByTpp': The corresponding TPP has terminated the consent by applying the DELETE method to the consent resource.</li> </ul> <p>The ASPSP might add further codes. These codes then shall be contained in the ASPSP's documentation of the XS2A interface and has to be added to this API definition as well.</p>

consentStatusResponse-200 Up

Body of the JSON response for a successful get status request for a consent.
consentStatus

consents Up

Content of the body of a consent request.
access
recurringIndicator
validUntil
frequencyPerDay
combinedServiceIndicator
Boolean If &quot;true&quot; indicates that a payment initiation service will be addressed in the same &quot;session&quot;.
example: false

consentsResponse-201 Up

Body of the JSON response for a successful conset request.
consentStatus
consentId
scaMethods (optional)
chosenScaMethod (optional)
challengeData (optional)
_links
message (optional)
String Text to be displayed to the PSU, e.g. in a Decoupled SCA Approach.

countryCode Up

ISO 3166 ALPHA2 country code

creditorAgentName Up

Creditor Agent Name

creditorName Up

Creditor Name

creditorNameAndAddress Up

Creditor Name and Address in a free text field

currencyCode Up

ISO 4217 Alpha 3 currency code

dayOfExecution Up

<p>Day of execution as string.</p> <p>This string consists of up two characters. Leading zeroes are not allowed.</p> <p>31 is ultimo of the month.</p>

debtorId Up

Debtor Id

debtorName Up

Debtor Name

endDate Up

The last applicable day of execution If not given, it is an infinite standing order.

entryReference Up

Is the identification of the transaction as used e.g. for reference for deltafunction on application level.

executionRule Up

&quot;following&quot; or &quot;preceding&quot; supported as values. This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the &quot;preceding&quot; or &quot;following&quot; working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule.

frequencyCode Up

<p>The following codes from the &quot;EventFrequency7Code&quot; of ISO 20022 are supported.</p> <ul> <li>&quot;Daily&quot;</li> <li>&quot;Weekly&quot;</li> <li>&quot;EveryTwoWeeks&quot;</li> <li>&quot;Monthly&quot;</li> <li>&quot;EveryTwoMonths&quot;</li> <li>&quot;Quarterly&quot;</li> <li>&quot;SemiAnnual&quot;</li> <li>&quot;Annual&quot;</li> </ul>

frequencyPerDay Up

<p>This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to &quot;1&quot;.</p> <p>The frequency needs to be greater equal to one.</p> <p>If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.</p>

fundsAvailable Up

<p>Equals true if sufficient funds are available at the time of the request, false otherwise.</p> <p>This datalemenet is allways contained in a confirmation of funds response.</p> <p>This data element is contained in a payment status response, if supported by the ASPSP, if a funds check has been performed and if the transactionStatus is &quot;ATCT&quot;, &quot;ACWC&quot; or &quot;ACCP&quot;.</p>

hrefEntry Up

Link to a resource

hrefType Up

Link to a resource
href (optional)

iban Up

IBAN of an account

inline_response_200 Up

account

inline_response_200_1 Up

transactionsDetails

inline_response_200_2 Up

cardAccount

inline_response_200_3 Up

Equals &quot;true&quot; if sufficient funds are available at the time of the request, &quot;false&quot; otherwise.
fundsAvailable

lastActionDate Up

This date is containing the date of the last action on the consent object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.

maskedPan Up

Masked Primary Account Number

merchantCategoryCode Up

Merchant category code

msisdn Up

Mobile phone number.

mt940 Up

Data MT940 format in a text structure.

mt942 Up

Data MT942 format in a text structure.

pan Up

Primary Account Number according to ISO/IEC 7812.

paymentExchangeRate Up

Exchange Rate
unitCurrency (optional)
exchangeRate (optional)
contractIdentification (optional)
rateType (optional)
Enum:
SPOT
SALE
AGRD

paymentId Up

Resource identification of the generated payment initiation resource.

paymentIdList Up

A list of paymentIds

paymentInitationRequestResponse-201 Up

Body of the response for a successful payment initiation request.
transactionStatus
paymentId
transactionFees (optional)
transactionFeeIndicator (optional)
scaMethods (optional)
chosenScaMethod (optional)
challengeData (optional)
_links
psuMessage (optional)
tppMessages (optional)

paymentInitiationBulkElement_json Up

<p>Generic body for a bulk payment initation entry.</p> <p>The bulk entry type is a type which follows the JSON formats for the supported products for single payments excluding the data elements (if supported):</p> <ul> <li>debtorAccount</li> <li>requestedExecutionDate,</li> <li>requestedExecutionTime. These data elements may not be contained in any bulk entry.</li> </ul> <p>This data object can be used to represent valid bulk payment initiations entry for the following JSON based payment product, which where defined in the Implementation Guidelines:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> </ul> <p>For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.</p> <p>Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.</p> <p>The following data element are depending on the actual payment product available (in source code):</p> <table style="width:100%"> <tr><th>Data Element</th><th>SCT EU Core</th><th>SCT INST EU Core</th><th>Target2 Paym. Core</th><th>Cross Border CT Core</th></tr> <tr><td>endToEndIdentification</td><td> optional</td> <td>optional</td> <td>optional</td> <td>n.a.</td> </tr> <tr><td>debtorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateDebtor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>instructedAmount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>transactionCurrency</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>exchangeRateInformation</td> <td>n.a.</td> <td>n.a.</td><td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAccount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorAgent</td> <td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorAgentName</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorName</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAddress</td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorNameAndAddress</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateCreditor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>purposeCode</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>chargeBearer</td> <td>n.a.</td> <td>n.a.</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>remittanceInformationUnstructured</td> <td>optional</td> <td>optional</td> <td> optional</td> <td>optional</td> </tr> <tr><td>remittanceInformationUnstructuredArray</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>remittanceInformationStructured</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> </td></tr> </table> <p>IMPORTANT: In this API definition the following holds:</p> <ul> <li>All data elements mentioned above are defined, but some of them are commented, i.e. they are only visible in the source code and can be used by uncommenting them.</li> <li>Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.</li> <li>Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.</li> <li>Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.</li> <li>Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.</li> <li>If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.</li> </ul>
endToEndIdentification (optional)
instructedAmount
creditorAccount
creditorAgent (optional)
creditorAgentName (optional)
creditorName
creditorAddress (optional)
remittanceInformationUnstructured (optional)

paymentInitiationCancelResponse-202 Up

Body of the response for a successful cancel payment request.
transactionStatus
scaMethods (optional)
chosenScaMethod (optional)
challengeData (optional)
_links (optional)

paymentInitiationCrossBorder_pain.001 Up

<p>A pain.001 structure corresponding to the cross-border schema</p> <p>For cross-border payments only community wide pain.001 schemes do exist.</p>

paymentInitiationSctInst_pain.001 Up

A pain.001 structure corresponding to the SCT INST schema.

paymentInitiationSct_pain.001 Up

<p>A pain.001 structure corresponding to the SCT schema</p> <p>urn:iso:std:iso:20022:tech:xsd:pain.001.001.03</p>

paymentInitiationStatusResponse-200_json Up

Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
transactionStatus
fundsAvailable (optional)

paymentInitiationStatusResponse-200_xml Up

<p>Body of the response for a successful payment initiation status request in case of an XML based endpoint.</p> <p>The status is returned as a pain.002 structure.</p> <p>urn:iso:std:iso:20022:tech:xsd:pain.002.001.03</p> <p>The chosen XML schema of the Status Request is following the XML schema definitions of the original pain.001 schema.</p>

paymentInitiationTarget2_pain.001 Up

<p>A pain.001 structure corresponding to the target-2 schema</p> <p>For TARGET-2 payments only community wide pain.001 schemes do exist.</p>

paymentInitiationWithStatusResponse Up

Generic JSON response body consistion of the corresponding payment initation JSON body together with an optional transaction status field.
endToEndIdentification (optional)
debtorAccount
instructedAmount
creditorAccount
creditorAgent (optional)
creditorName
creditorAddress (optional)
remittanceInformationUnstructured (optional)
transactionStatus (optional)

paymentInitiation_json Up

<p>Generic Body for a payment initation via JSON.</p> <p>This generic JSON body can be used to represent valid payment initiations for the following JSON based payment product, which where defined in the Implementation Guidelines:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> </ul> <p>For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.</p> <p>Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.</p> <p>The following data element are depending on the actual payment product available (in source code):</p> <table style="width:100%"> <tr><th>Data Element</th><th>SCT EU Core</th><th>SCT INST EU Core</th><th>Target2 Paym. Core</th><th>Cross Border CT Core</th></tr> <tr><td>endToEndIdentification</td><td> optional</td> <td>optional</td> <td>optional</td> <td>n.a.</td> </tr> <tr><td>debtorAccount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>debtorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateDebtor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>instructedAmount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>transactionCurrency</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>exchangeRateInformation</td> <td>n.a.</td> <td>n.a.</td><td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAccount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorAgent</td> <td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorAgentName</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorName</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAddress</td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorNameAndAddress</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateCreditor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>purposeCode</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>chargeBearer</td> <td>n.a.</td> <td>n.a.</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>remittanceInformationUnstructured</td> <td>optional</td> <td>optional</td> <td> optional</td> <td>optional</td> </tr> <tr><td>remittanceInformationUnstructuredArray</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>remittanceInformationStructured</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>requestedExecutionDate</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>requestedExecutionTime</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> </td></tr> </table> <p>IMPORTANT: In this API definition the following holds:</p> <ul> <li>All data elements mentioned above are defined, but some of them are commented, i.e. they are only visible in the source code and can be used by uncommenting them.</li> <li>Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.</li> <li>Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.</li> <li>Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.</li> <li>Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.</li> <li>If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.</li> </ul>
endToEndIdentification (optional)
debtorAccount
instructedAmount
creditorAccount
creditorAgent (optional)
creditorAgentName (optional)
creditorName
creditorAddress (optional)
remittanceInformationUnstructured (optional)

periodicPaymentInitiationMultipartBody Up

The multipart message definition for the initiation of a periodic payment initiation where the information of the payment is contained in an pain.001 message (Part 1) and the additional informations related to the periodic payment is an additional JSON message (Part 2).
xml_sct (optional)
json_standingorderType (optional)

periodicPaymentInitiationWithStatusResponse Up

Generic JSON response body consistion of the corresponding periodic payment initation JSON body together with an optional transaction status field.
endToEndIdentification (optional)
debtorAccount
instructedAmount
creditorAccount
creditorAgent (optional)
creditorName
creditorAddress (optional)
remittanceInformationUnstructured (optional)
startDate
endDate (optional)
executionRule (optional)
frequency
dayOfExecution (optional)
transactionStatus (optional)

periodicPaymentInitiation_json Up

<p>Generic Body for a periodic payment initation via JSON.</p> <p>This generic JSON body can be used to represent valid periodic payment initiations for the following JSON based payment product, which where defined in the Implementation Guidelines:</p> <ul> <li>sepa-credit-transfers</li> <li>instant-sepa-credit-transfers</li> <li>target-2-payments</li> <li>cross-border-credit-transfers</li> </ul> <p>For the convenience of the implementer additional which are already predefinded in the Implementation Guidelines are included (but commented in source code), such that an ASPSP may add them easily.</p> <p>Take care: Since the format is intended to fit for all payment products there are additional conditions which are NOT covered by this specification. Please check the Implementation Guidelines for detailes.</p> <p>The following data element are depending on the actual payment product available (in source code):</p> <table style="width:100%"> <tr><th>Data Element</th><th>SCT EU Core</th><th>SCT INST EU Core</th><th>Target2 Paym. Core</th><th>Cross Border CT Core</th></tr> <tr><td>endToEndIdentification</td><td> optional</td> <td>optional</td> <td>optional</td> <td>n.a.</td> </tr> <tr><td>debtorAccount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>debtorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateDebtor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>instructedAmount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>transactionCurrency</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>exchangeRateInformation</td> <td>n.a.</td> <td>n.a.</td><td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAccount</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorAgent</td> <td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorAgentName</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorName</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>creditorId</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>creditorAddress</td>optional</td> <td>optional</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>creditorNameAndAddress</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>ultimateCreditor</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>purposeCode</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>chargeBearer</td> <td>n.a.</td> <td>n.a.</td> <td>optional</td> <td>conditional </td> </tr> <tr><td>remittanceInformationUnstructured</td> <td>optional</td> <td>optional</td> <td> optional</td> <td>optional</td> </tr> <tr><td>remittanceInformationUnstructuredArray</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>remittanceInformationStructured</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>requestedExecutionDate</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>requestedExecutionTime</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> <td>n.a.</td> </tr> <tr><td>startDate</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>executionRule</td> <td>optional</td> <td>optional</td> <td>optional</td> <td>optional</td> </tr> <tr><td>endDate</td> <td>optional</td> <td>optional</td> <td>optional</td> <td>optional</td> </tr> <tr><td>frequency</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> <td>mandatory</td> </tr> <tr><td>dayOfExecution</td> <td>conditional</td> <td>conditional</td> <td>conditional</td> <td>conditional</td> </tr> </td></tr> </table> <p>IMPORTANT: In this API definition the following holds:</p> <ul> <li>All data elements mentioned above are defined, but some of them are commented, i.e. they are only visible in the source code and can be used by uncommenting them.</li> <li>Data elements which are mandatory in the table above for all payment products are set to be mandatory in this specification.</li> <li>Data elements which are indicated in the table above as n.a. for all payment products are commented in the source code.</li> <li>Data elements which are indicated to be option, conditional or mandatory for at least one payment product in the table above are set to be optional in the s specification except the case where all are definde to be mandatory.</li> <li>Data element which are inticated to be n.a. can be used by the ASPS if needed. In this case uncomment tthe the relatetd lines in the source code.</li> <li>If one uses this data types for some payment products he has to ensure that the used data type is valid according to the underlying payment product, e.g. by some appropriate validations.</li> </ul>
endToEndIdentification (optional)
debtorAccount
instructedAmount
creditorAccount
creditorAgent (optional)
creditorName
creditorAddress (optional)
remittanceInformationUnstructured (optional)
startDate
endDate (optional)
executionRule (optional)
frequency
dayOfExecution (optional)

periodicPaymentInitiation_xml-Part2-standingorderType_json Up

The body part 2 of a periodic payment initation request containes the execution related informations of the periodic payment.
startDate
endDate (optional)
executionRule (optional)
frequency
dayOfExecution (optional)

proprietaryBankTransactionCode Up

Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.

psuData Up

PSU Data for Update PSU Authentication.
password (optional)
String Password
encryptedPassword (optional)
String Encrypted password.
additionalPassword (optional)
String Additional password in plaintext
additionalEncryptedPassword (optional)
String Additional encrypted password

psuMessageText Up

Text to be displayed to the PSU

purposeCode Up

<p>ExternalPurpose1Code from ISO 20022.</p> <p>Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.</p>

readAccountBalanceResponse-200 Up

Body of the response for a successful read balance for an account request.
account (optional)
balances

readCardAccountBalanceResponse-200 Up

Body of the response for a successful read balance for a card account request.
cardAccount (optional)
balances

recurringIndicator Up

<p>&quot;true&quot;, if the consent is for recurring access to the account data.</p> <p>&quot;false&quot;, if the consent is for one access to the account data.</p>

remittanceInformationStructured Up

Structured remittance information
reference
referenceType (optional)
referenceIssuer (optional)

remittanceInformationUnstructured Up

Unstructured remittance information

remittanceInformationUnstructuredArray Up

Array of unstructured remittance information

reportExchangeRate Up

Exchange Rate
sourceCurrency
exchangeRate
unitCurrency
targetCurrency
quotationDate
date format: date
contractIdentification (optional)

reportExchangeRateList Up

Array of exchange rates

scaAuthenticationData Up

SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded.

scaMethods Up

<p>This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.</p> <p>Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported.</p> <p>If this data element is contained, then there is also an hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body.</p> <p>These methods shall be presented towards the PSU for selection by the TPP.</p>

scaStatus Up

<p>This data element is containing information about the status of the SCA method applied.</p> <p>The following codes are defined for this data type.</p> <ul> <li>'received': An authorisation or cancellation-authorisation resource has been created successfully.</li> <li>'psuIdentified': The PSU related to the authorisation or cancellation-authorisation resource has been identified.</li> <li>'psuAuthenticated': The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.</li> <li>'scaMethodSelected': The PSU/TPP has selected the related SCA routine. If the SCA method is chosen implicitly since only one SCA method is available, then this is the first status to be reported instead of 'received'.</li> <li>'started': The addressed SCA routine has been started.</li> <li>'finalised': The SCA routine has been finalised successfully.</li> <li>'failed': The SCA routine failed</li> <li>'exempted': SCA was exempted for the related transaction, the related authorisation is successful.</li> </ul>

scaStatusResponse Up

Body of the JSON response with SCA Status
scaStatus (optional)

selectPsuAuthenticationMethod Up

Content of the body of a Select PSU Authentication Method Request
authenticationMethodId

selectPsuAuthenticationMethodResponse Up

Body of the JSON response for a successful select PSU Authentication Method request.
chosenScaMethod (optional)
challengeData (optional)
_links (optional)
scaStatus
psuMessage (optional)

signingBasket Up

JSON Body of a establish signing basket request. The body shall contain at least one entry.
paymentIds (optional)
consentIds (optional)

signingBasketResponse-200 Up

<p>Body of the JSON response for a successful get signing basket request.</p> <ul> <li>'payments': payment initiations which shall be authorised through this signing basket.</li> <li>'consents': consent objects which shall be authorised through this signing basket.</li> <li>'transactionStatus': Only the codes RCVD, ACTC, RJCT are used.</li> <li>'_links': The ASPSP might integrate hyperlinks to indicate next (authorisation) steps to be taken.</li> </ul>
payments (optional)
consents (optional)
transactionStatus
_links (optional)

signingBasketResponse-201 Up

Body of the JSON response for a successful create signing basket request.
transactionStatus
basketId
scaMethods (optional)
chosenScaMethod (optional)
challengeData (optional)
_links
psuMessage (optional)
tppMessages (optional)

signingBasketStatusResponse-200 Up

transactionStatus

startDate Up

The first applicable day of execution starting from this date is the first payment.

startScaprocessResponse Up

Body of the JSON response for a Start SCA authorisation request.
scaStatus
authorisationId
scaMethods (optional)
chosenScaMethod (optional)
challengeData (optional)
_links
psuMessage (optional)

terminalId Up

Identification of the Terminal, where the card has been used.

tppErrorDetail Up

Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.

tppErrorTitle Up

Short human readable description of error type. Could be in local language. To be provided by ASPSPs.

tppMessage2XX Up

category
code
path (optional)
text (optional)

tppMessage400_AIS Up

category
code
path (optional)
text (optional)

tppMessage400_PIIS Up

category
code
path (optional)
text (optional)

tppMessage400_PIS Up

category
code
path (optional)
text (optional)

tppMessage400_SBS Up

category
code
path (optional)
text (optional)

tppMessage401_AIS Up

category
code
path (optional)
text (optional)

tppMessage401_PIIS Up

category
code
path (optional)
text (optional)

tppMessage401_PIS Up

category
code
path (optional)
text (optional)

tppMessage401_SBS Up

category
code
path (optional)
text (optional)

tppMessage403_AIS Up

category
code
path (optional)
text (optional)

tppMessage403_PIIS Up

category
code
path (optional)
text (optional)

tppMessage403_PIS Up

category
code
path (optional)
text (optional)

tppMessage403_SBS Up

category
code
path (optional)
text (optional)

tppMessage404_AIS Up

category
code
path (optional)
text (optional)

tppMessage404_PIIS Up

category
code
path (optional)
text (optional)

tppMessage404_PIS Up

category
code
path (optional)
text (optional)

tppMessage404_SBS Up

category
code
path (optional)
text (optional)

tppMessage405_AIS Up

category
code
path (optional)
text (optional)

tppMessage405_PIIS Up

category
code
path (optional)
text (optional)

tppMessage405_PIS Up

category
code
path (optional)
text (optional)

tppMessage405_PIS_CANC Up

category
code
path (optional)
text (optional)

tppMessage405_SBS Up

category
code
path (optional)
text (optional)

tppMessage406_AIS Up

category
code
path (optional)
text (optional)

tppMessage409_AIS Up

category
code
path (optional)
text (optional)

tppMessage409_PIIS Up

category
code
path (optional)
text (optional)

tppMessage409_PIS Up

category
code
path (optional)
text (optional)

tppMessage409_SBS Up

category
code
path (optional)
text (optional)

tppMessage429_AIS Up

category
code
path (optional)
text (optional)

tppMessageCategory Up

Category of the TPP message category

tppMessageText Up

Additional explaining text to the TPP.

transactionAuthorisation Up

Content of the body of a Transaction Authorisation Request
scaAuthenticationData

transactionDate Up

Date of the actual card transaction

transactionDetails Up

Transaction details
transactionId (optional)
String the Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request
entryReference (optional)
String Is the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.
endToEndId (optional)
String Unique end to end identity.
mandateId (optional)
String Identification of Mandates, e.g. a SEPA Mandate ID.
checkId (optional)
String Identification of a Cheque.
creditorId (optional)
String Identification of Creditors, e.g. a SEPA Creditor ID.
bookingDate (optional)
valueDate (optional)
date The Date at which assets become available to the account owner in case of a credit. format: date
transactionAmount
currencyExchange (optional)
creditorName (optional)
creditorAccount (optional)
ultimateCreditor (optional)
debtorName (optional)
debtorAccount (optional)
ultimateDebtor (optional)
remittanceInformationUnstructured (optional)
remittanceInformationStructured (optional)
String <p>Reference as contained in the structured remittance reference structure (without the surrounding XML structure).</p> <p>Different from other places the content is containt in plain form not in form of a structered field.</p>
additionalInformation (optional)
String Might be used by the ASPSP to transport additional transaction related information to the PSU.
purposeCode (optional)
bankTransactionCode (optional)
proprietaryBankTransactionCode (optional)
_links (optional)

transactionFeeIndicator Up

If equals 'true', the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals 'false', the transaction will not involve additional specific transaction costs to the PSU.

transactionId Up

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

transactionList Up

Array of transaction details

transactionStatus Up

<p>The transaction status is filled with codes of the ISO 20022 data table:</p> <ul> <li> <p>'ACCC': 'AcceptedSettlementCompleted' - Settlement on the creditor's account has been completed.</p> </li> <li> <p>'ACCP': 'AcceptedCustomerProfile' - Preceding check of technical validation was successful. Customer profile check was also successful.</p> </li> <li> <p>'ACSC': 'AcceptedSettlementCompleted' - Settlement on the debtor�s account has been completed.</p> <p><strong>Usage:</strong> this can be used by the first agent to report to the debtor that the transaction has been completed.</p> <p><strong>Warning:</strong> this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement.</p> </li> <li> <p>'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.</p> </li> <li> <p>'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful.</p> </li> <li> <p>'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent.</p> </li> <li> <p>'ACWP': 'AcceptedWithoutPosting' - Payment instruction included in the credit transfer is accepted without being posted to the creditor customer�s account.</p> </li> <li> <p>'RCVD': 'Received' - Payment initiation has been received by the receiving agent.</p> </li> <li> <p>'PDNG': 'Pending' - Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.</p> </li> <li> <p>'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.</p> </li> <li> <p>'CANC': 'Cancelled' Payment initiation has been cancelled before execution Remark: This codeis accepted as new code by ISO20022.</p> </li> <li> <p>'ACFC': 'AcceptedFundsChecked' - Preceding check of technical validation and customer profile was successful and an automatic funds check was positive . Remark: This code is accepted as new code by ISO20022.</p> </li> <li> <p>'PATC': 'PartiallyAcceptedTechnical' Correct The payment initiation needs multiple authentications, where some but not yet all have been performed. Syntactical and semantical validations are successful. Remark: This code is accepted as new code by ISO20022.</p> </li> <li> <p>'PART': 'PartiallyAccepted' - A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status. Remark: This code may be used only in case of bulk payments. It is only used in a situation where all mandated authorisations have been applied, but some payments have been rejected.</p> </li> </ul>

transactionStatus_SBS Up

<p>The transaction status is filled with codes of the ISO 20022 data table. Only the codes RCVD, PATC, ACTC, ACWC and RJCT are used:</p> <ul> <li>'ACSP': 'AcceptedSettlementInProcess' - All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.</li> <li>'ACTC': 'AcceptedTechnicalValidation' - Authentication and syntactical and semantical validation are successful.</li> <li>'ACWC': 'AcceptedWithChange' - Instruction is accepted but a change will be made, such as date or remittance not sent.</li> <li>'RCVD': 'Received' - Payment initiation has been received by the receiving agent.</li> <li>'RJCT': 'Rejected' - Payment initiation or individual transaction included in the payment initiation has been rejected.</li> </ul>

transactionsResponse-200_json Up

Body of the JSON response for a successful read transaction list request. This account report contains transactions resulting from the query parameters.
account (optional)
transactions (optional)
balances (optional)
_links (optional)

ultimateCreditor Up

Ultimate Creditor

ultimateDebtor Up

Ultimate Debtor

updatePsuAuthentication Up

<p>Content of the body of a Update PSU Authentication Request</p> <p>Password subfield is used.</p>
psuData

updatePsuAuthenticationResponse Up

Body of the JSON response for a successful update PSU Authentication request.
chosenScaMethod (optional)
challengeData (optional)
scaMethods (optional)
_links (optional)
scaStatus
psuMessage (optional)

updatePsuIdenticationResponse Up

Body of the JSON response for a successful update PSU Identification request.
scaMethods (optional)
_links
scaStatus
psuMessage (optional)

validUntil Up

<p>This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30.</p> <p>Future dates might get adjusted by ASPSP.</p> <p>If a maximal available date is requested, a date in far future is to be used: &quot;9999-12-31&quot;.</p> <p>In both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.</p>