Payment Initiation Service (PIS)
Confirmation of Funds Service (PIIS)
Account Information Service (AIS)
Signing Baskets
Common Services
CEC Bank version of Berlin Group PSD2 compliant API
CEC Bank API developers group
production
https://api.cec.ro/cec/prod
Paths
/v1/consents
/v1/consents/{consentId}
/v1/consents/{consentId}/status
/v1/consents/{consentId}/authorisations
/v1/consents/{consentId}/authorisations/{authorisationId}
Definitions
The transaction status is filled with codes of the ISO 20022 data table: ACCC: AcceptedSettlementCompleted ,ACCP: AcceptedCustomerProfile
{
"type": "string"
}
The transaction status is filled with codes of the ISO 20022 data table.Only the codes RCVD, PATC, ACTC, ACWC and RJCT are used
{
"type": "string"
}
This data element is containing information about the status of the SCA method applied.
{
"type": "string"
}
This is the overall lifecycle status of the consent.
{
"type": "string"
}
Authentication Object
{
"type": "object",
"properties": {
"authenticationType": {
"$ref": "#\/definitions\/authenticationType"
},
"authenticationVersion": {
"description": "Depending on the authenticationType.This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type.",
"type": "string"
},
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"type": "string",
"maxLength": 35
},
"name": {
"description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP.",
"type": "string"
},
"explanation": {
"description": "Detailed information about the SCA method for the PSU.",
"type": "string"
}
},
"required": [
"authenticationType",
"authenticationMethodId"
]
}
Type of the authentication method.
{
"type": "string"
}
JSON Body of a establish signing basket request.The body shall contain at least one entry.
{
"type": "object",
"properties": {
"paymentIds": {
"description": "A list of paymentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"consentIds": {
"description": "A list of consentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
}
}
It is contained in addition to the data element chosenScaMethod if challenge data is needed for SCA.
{
"type": "object",
"properties": {
"image": {
"description": "PNG data (max. 512 kilobyte) to be displayed to the PSU,nBase64 encoding, cp. [RFC4648].",
"type": "string"
},
"data": {
"description": "String challenge data",
"type": "string"
},
"imageLink": {
"description": "A link where the ASPSP will provides the challenge image for the TPP.",
"type": "string"
},
"otpMaxLength": {
"description": "The maximal length for the OTP to be typed in by the PSU.",
"type": "integer",
"format": "int32"
},
"otpFormat": {
"$ref": "#\/definitions\/OtpFormat"
},
"additionalInformation": {
"description": "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.",
"type": "string"
}
}
}
An array of all authorisationIds
{
"title": "authorisations",
"type": "object",
"properties": {
"authorisationIds": {
"description": "An array of all authorisationIds",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"authorisationIds"
]
}
Reference to an account by either IBAN, of a payment accounts, or BBAN, for payment accounts if there is no IBAN, or the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, the Primary Account Number (PAN) of a card in a masked form, or an alias to access a payment account via a registered mobile phone number (MSISDN).
{
"title": "accountReference",
"type": "object",
"properties": {
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"pan": {
"description": "Primary Account Number according to ISO\/IEC 7812.",
"example": "5409050000000000",
"type": "string",
"maxLength": 35
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
}
}
}
The following balance types are defined:closingBooked,interimAvailable,forwardAvailable,nonInvoiced.
{
"title": "balanceType",
"example": "closingBooked",
"type": "string"
}
Requested access services for a consent.
{
"title": "accountAccess",
"type": "object",
"properties": {
"accounts": {
"description": "Is asking for detailed account information. If the array is empty, the TPP is asking for an accessible account list. This may be restricted in a PSU\/ASPSP authorization dialogue.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"balances": {
"description": "Is asking for balances of the addressed accounts.If the array is empty, the TPP is asking for the balances of all accessible account lists.",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"transactions": {
"description": "Is asking for transactions of the addressed accounts. If the array is empty, the TPP is asking for the transactions of all accessible account lists. ",
"type": "array",
"items": {
"$ref": "#\/definitions\/accountReference"
}
},
"availableAccounts": {
"$ref": "#\/definitions\/AvailableAccounts"
},
"allPsd2": {
"$ref": "#\/definitions\/AllPsd2"
}
}
}
Account status. The value is one of the following:enabled, deleted,blocked.
{
"title": "accountStatus",
"example": "enabled",
"type": "string"
}
The ASPSP shall give at least one of the account reference identifiers:iban,bban,pan,maskedPan,msisdn
{
"title": "accountDetails",
"type": "object",
"properties": {
"resourceId": {
"description": "This shall be filled, if addressable resource are created by the ASPSP on the accounts or card-accounts endpoint.",
"type": "string"
},
"iban": {
"description": "IBAN of an account",
"example": "FR7612345987650123456789014",
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
},
"bban": {
"description": "Basic Bank Account Number (BBAN) Identifier",
"example": "BARC12345612345678",
"type": "string",
"pattern": "[a-zA-Z0-9]{1,30}"
},
"msisdn": {
"description": "Mobile phone number.",
"example": "+49 170 1234567",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account given by the bank or the PSU in online-banking.",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"cashAccountType": {
"description": "ExternalCashAccountType1Code from ISO 20022.",
"type": "string"
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"bic": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"linkedAccounts": {
"description": "Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.",
"type": "string",
"maxLength": 70
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP",
"type": "string",
"maxLength": 140
},
"balances": {
"description": "A list of balances regarding this account, e.g. the current balance, the last booked balance.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"description": "Links to the account, which can be directly used for retrieving account information from this dedicated account.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"currency"
]
}
Card account details
{
"title": "cardAccountDetails",
"type": "object",
"properties": {
"resourceId": {
"description": "This is the data element to be used in the path when retrieving data from a dedicated account.",
"type": "string"
},
"maskedPan": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"name": {
"description": "Name of the account given by the bank or the PSU in online-banking.",
"type": "string",
"maxLength": 35
},
"product": {
"description": "Product name of the bank for this account, proprietary definition.",
"type": "string",
"maxLength": 35
},
"status": {
"$ref": "#\/definitions\/accountStatus"
},
"usage": {
"$ref": "#\/definitions\/Usage"
},
"details": {
"description": "Specifications that might be provided by the ASPSP",
"type": "string",
"maxLength": 140
},
"creditLimit": {
"$ref": "#\/definitions\/amount"
},
"balances": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"description": "Links to the account, which can be directly used for retrieving account information from this dedicated account.Links to balances and or transactions",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"maskedPan",
"currency"
]
}
List of accounts with details.
{
"title": "accountList",
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/accountDetails"
}
}
},
"required": [
"accounts"
]
}
List of card accounts with details.
{
"title": "cardAccountList",
"type": "object",
"properties": {
"cardAccounts": {
"type": "array",
"items": {
"$ref": "#\/definitions\/cardAccountDetails"
}
}
},
"required": [
"cardAccounts"
]
}
JSON based account report.This account report contains transactions resulting from the query parameters.
{
"title": "accountReport",
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/transactionDetails"
}
},
"_links": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"_links"
]
}
JSON based card account report.This card account report contains transactions resulting from the query parameters.
{
"title": "cardAccountReport",
"type": "object",
"properties": {
"booked": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"pending": {
"description": "Array of transaction details",
"type": "array",
"items": {
"$ref": "#\/definitions\/cardTransaction"
}
},
"_links": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"booked",
"_links"
]
}
Transaction details
{
"title": "transactionDetails",
"type": "object",
"properties": {
"transactionId": {
"description": "the Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. ",
"type": "string"
},
"entryReference": {
"description": "Is the identification of the transaction as used e.g. for reference for deltafunction on application level. ",
"type": "string",
"maxLength": 35
},
"endToEndId": {
"description": "Unique end to end identity.",
"type": "string",
"maxLength": 35
},
"mandateId": {
"description": "Identification of Mandates, e.g. a SEPA Mandate ID.",
"type": "string",
"maxLength": 35
},
"checkId": {
"description": "Identification of a Cheque.",
"type": "string",
"maxLength": 35
},
"creditorId": {
"description": "Identification of Creditors, e.g. a SEPA Creditor ID.",
"type": "string",
"maxLength": 35
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"valueDate": {
"description": "The Date at which assets become available to the account owner in case of a credit.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"exchangeRate": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/exchangeRate"
}
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateCreditor": {
"description": "Ultimate Creditor",
"example": "Ultimate Creditor",
"type": "string",
"maxLength": 70
},
"debtorName": {
"description": "Debtor Name",
"example": "Debtor Name",
"type": "string",
"maxLength": 70
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"ultimateDebtor": {
"description": "Ultimate Debtor",
"example": "Ultimate Debtor",
"type": "string",
"maxLength": 70
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"remittanceInformationStructured": {
"description": "Reference as contained in the structured remittance reference structure (without the surrounding XML structure).",
"type": "string",
"maxLength": 140
},
"purposeCode": {
"$ref": "#\/definitions\/purposeCode"
},
"bankTransactionCode": {
"description": "Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022. ",
"example": "PMNT-RCDT-ESCT",
"type": "string"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.",
"type": "string",
"maxLength": 35
},
"_links": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"transactionAmount"
]
}
Card transaction information
{
"title": "cardTransaction",
"type": "object",
"properties": {
"cardTransactionId": {
"description": "Unique end to end identity.",
"type": "string",
"maxLength": 35
},
"terminalId": {
"description": "Identification of the Terminal, where the card has been used.",
"type": "string",
"maxLength": 35
},
"transactionDate": {
"description": "Date of the actual card transaction",
"type": "string",
"format": "date"
},
"bookingDate": {
"description": "The Date when an entry is posted to an account on the ASPSPs books.",
"type": "string",
"format": "date"
},
"transactionAmount": {
"$ref": "#\/definitions\/amount"
},
"exchangeRate": {
"description": "Array of exchange rates",
"type": "array",
"items": {
"$ref": "#\/definitions\/exchangeRate"
}
},
"originalAmount": {
"$ref": "#\/definitions\/amount"
},
"markupFee": {
"$ref": "#\/definitions\/amount"
},
"markupFeePercentage": {
"type": "string"
},
"cardAcceptorId": {
"type": "string",
"maxLength": 35
},
"cardAcceptorAddress": {
"$ref": "#\/definitions\/address"
},
"cardAcceptorCategoryCode": {
"description": "Card Acceptor Category Code of the Card Acceptor as given in the related card transaction.",
"type": "string"
},
"maskedPAN": {
"description": "Masked Primary Account Number",
"example": "123456xxxxxx1234",
"type": "string",
"maxLength": 35
},
"transactionDetails": {
"type": "string",
"maxLength": 140
},
"invoiced": {
"type": "boolean"
},
"proprietaryBankTransactionCode": {
"description": "Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.",
"type": "string",
"maxLength": 35
}
},
"required": [
"transactionAmount"
]
}
Exchange Rate
{
"title": "exchangeRate",
"type": "object",
"properties": {
"sourceCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"rate": {
"type": "string"
},
"unitCurrency": {
"type": "string"
},
"targetCurrency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"rateDate": {
"type": "string",
"format": "date"
},
"rateContract": {
"type": "string"
}
},
"required": [
"sourceCurrency",
"rate",
"unitCurrency",
"targetCurrency",
"rateDate"
]
}
A single balance element
{
"title": "balance",
"type": "object",
"properties": {
"balanceAmount": {
"$ref": "#\/definitions\/amount"
},
"balanceType": {
"$ref": "#\/definitions\/balanceType"
},
"lastChangeDateTime": {
"description": "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.",
"type": "string",
"format": "date-time"
},
"referenceDate": {
"description": "Reference date of the balance",
"type": "string",
"format": "date"
},
"lastCommittedTransaction": {
"description": "entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.",
"type": "string",
"maxLength": 35
}
},
"required": [
"balanceAmount",
"balanceType"
]
}
{
"title": "address",
"type": "object",
"properties": {
"street": {
"type": "string",
"maxLength": 70
},
"buildingNumber": {
"type": "string"
},
"city": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"country": {
"description": "ISO 3166 ALPHA2 country code",
"example": "SE",
"type": "string",
"pattern": "[A-Z]{2}"
}
},
"required": [
"country"
]
}
{
"title": "amount",
"example": {
"currency": "EUR",
"amount": "123"
},
"type": "object",
"properties": {
"currency": {
"description": "ISO 4217 Alpha 3 currency code",
"example": "EUR",
"type": "string",
"pattern": "[A-Z]{3}"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.",
"example": "5877.78",
"type": "string",
"pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
}
},
"required": [
"currency",
"amount"
]
}
Structured remittance information
{
"title": "remittanceInformationStructured",
"type": "object",
"properties": {
"reference": {
"type": "string",
"maxLength": 35
},
"referenceType": {
"type": "string",
"maxLength": 35
},
"referenceIssuer": {
"type": "string",
"maxLength": 35
}
},
"required": [
"reference"
]
}
ExternalPurpose1Code from ISO 20022.Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
{
"title": "purposeCode",
"example": "BKDF",
"type": "string"
}
The following codes from the EventFrequency7Code of ISO 20022 are supported.
{
"title": "frequencyCode",
"example": "Daily",
"type": "string"
}
Day of execution as string.This string consists of up two characters.Leading zeroes are not allowed.31 is ultimo of the month.
{
"title": "dayOfExecution",
"example": 1,
"type": "integer",
"format": "int32"
}
following or preceeding supported as values. This data attribute defines the behavior when recurring payment dates falls on a weekend or bank holiday.
{
"title": "executionRule",
"example": "following",
"type": "string"
}
PSU Data for Update PSU Authentication.
{
"title": "psuData",
"type": "object",
"properties": {
"password": {
"description": "Password",
"type": "string"
}
},
"required": [
"password"
]
}
Body for a SCT payment initation.
{
"title": "paymentInitiationSct_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Body for a SCT INST payment initation.
{
"title": "paymentInitiationSctInst_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Body for a TARGET-2 payment initation.
{
"title": "paymentInitiationTarget2_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON body for a cross-border payment initation.
{
"title": "paymentInitiationCrossBorder_json",
"type": "object",
"properties": {
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Body for a bulk SCT payment initation.
{
"title": "paymentInitiationSctBulkElement_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Body for a SCT INST payment initation.
{
"title": "paymentInitiationSctInstBulkElement_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
Body for a bulk TARGET-2 payment initation.
{
"title": "paymentInitiationTarget2BulkElement_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON body for a cross-border payment initation.
{
"title": "paymentInitiationCrossBorderBulkElement_json",
"type": "object",
"properties": {
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON Body for a periodic SCT payment initation.
{
"title": "periodicPaymentInitiationSct_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution.If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON Body for a periodic SCT INST payment initation.
{
"title": "periodicPaymentInitiationSctInst_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution. If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON Body for a periodic target-2 payment initation.
{
"title": "periodicPaymentInitiationTarget2_json",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution. If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON body for a periodic cross-border payment initation.
{
"title": "periodicPaymentInitiationCrossBorder_json",
"type": "object",
"properties": {
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON Body for a bulk SCT payment initation.
{
"title": "bulkPaymentInitiationSct_json",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "If this element equals true, the PSU prefers only one booking entry. If equals false, the PSU prefers individual booking of all contained individual transactions.",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for SCT payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationSctBulkElement_json"
}
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON Body for a bulk SCT INST payment initation.
{
"title": "bulkPaymentInitiationSctInst_json",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. ",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for SCT INST payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationSctInstBulkElement_json"
}
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON Body for a bulk TARGET-2 payment initation.
{
"title": "bulkPaymentInitiationTarget2_json",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. ",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for TARGET-2 payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationTarget2BulkElement_json"
}
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON body for a bulk cross-border payment initation.
{
"title": "bulkPaymentInitiationCrossBorder_json",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. ",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A List of JSON bodies for cross-border payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationCrossBorderBulkElement_json"
}
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON Request body for the Confirmation of Funds Service
{
"title": "confirmationOfFunds",
"type": "object",
"properties": {
"cardNumber": {
"description": "Card Number of the card issued by the PIISP. Should be delivered if available.",
"type": "string"
},
"account": {
"$ref": "#\/definitions\/accountReference"
},
"payee": {
"description": "Name payee",
"type": "string",
"maxLength": 70
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
}
},
"required": [
"account",
"instructedAmount"
]
}
Content of the body of a consent request.
{
"title": "consents",
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "true, if the consent is for recurring access to the account data,false if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent.",
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day.For a one-off access, this attribute is set to 1.",
"example": 4,
"type": "integer",
"format": "int32"
},
"combinedServiceIndicator": {
"description": "If true indicates that a payment initiation service will be addressed in the same session.",
"example": false,
"type": "boolean"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"combinedServiceIndicator"
]
}
Content of the body of a Update PSU Authentication Request.Password subfield is used.
{
"title": "updatePsuAuthentication",
"type": "object",
"properties": {
"psuData": {
"$ref": "#\/definitions\/psuData"
}
},
"required": [
"psuData"
]
}
Content of the body of a Select PSU Authentication Method Request
{
"title": "selectPsuAuthenticationMethod",
"type": "object",
"properties": {
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.",
"example": "myAuthenticationID",
"type": "string",
"maxLength": 35
}
},
"required": [
"authenticationMethodId"
]
}
Content of the body of a Transaction Authorisation Request
{
"title": "transactionAuthorisation",
"type": "object",
"properties": {
"scaAuthenticationData": {
"description": "SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded.",
"type": "string"
}
},
"required": [
"scaAuthenticationData"
]
}
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 and the additional informations related to the periodic payment is an additional JSON message .
{
"title": "periodicPaymentInitiationMultipartBody",
"type": "object",
"properties": {
"xml_sct": {
"type": "object"
},
"json_standingorderType": {
"$ref": "#\/definitions\/periodicPaymentInitiation_xml-Part2-standingorderType_json"
}
}
}
The body part 2 of a periodic payment initation request containes the execution related informations of the periodic payment.
{
"title": "periodicPaymentInitiation_xml-Part2-standingorderType_json",
"type": "object",
"properties": {
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
}
},
"required": [
"startDate",
"frequency"
]
}
Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
{
"title": "paymentInitiationStatusResponse-200_json",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"transactionStatus"
]
}
Body of the response for a successful payment initiation request.
{
"title": "paymentInitationRequestResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.",
"example": "1234-wertiq-983",
"type": "string"
},
"transactionFees": {
"$ref": "#\/definitions\/amount"
},
"transactionFeeIndicator": {
"description": "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.",
"type": "boolean"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "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.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"paymentId",
"_links"
]
}
Body of the response for a successful payment initiation request.
{
"title": "paymentInitationRequestMultiLevelScaResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.",
"example": "1234-wertiq-983",
"type": "string"
},
"transactionFees": {
"$ref": "#\/definitions\/amount"
},
"transactionFeeIndicator": {
"description": "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.",
"type": "boolean"
},
"_links": {
"description": "Type of links admitted in this response",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"paymentId",
"_links"
]
}
Body of the response for a successful cancel payment request.
{
"title": "paymentInitiationCancelResponse-204_202",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP. All links can be relative or full links, to be decided by the ASPSP.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"transactionStatus"
]
}
JSON response body consistion of the corresponding SCT payment initation JSON body together with an optional transaction status field.
{
"title": "paymentInitiationSctWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON response body consistion of the corresponding SCT INST payment initation JSON body together with an optional transaction status field.
{
"title": "paymentInitiationSctInstWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON response body consistion of the corresponding TARGET-2 payment initation JSON body together with an optional transaction status field.
{
"title": "paymentInitiationTarget2WithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON response body consistion of the corresponding cross-border payment initation JSON body together with an optional transaction status field.
{
"title": "paymentInitiationCrossBorderWithStatusResponse",
"type": "object",
"properties": {
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName"
]
}
JSON response body consistion of the corresponding periodic SCT payment initation JSON body together with an optional transaction status field.
{
"title": "periodicPaymentInitiationSctWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON response body consistion of the corresponding periodic SCT INST payment initation JSON body together with an optional transaction status field.
{
"title": "periodicPaymentInitiationSctInstWithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured remittance information",
"example": "Ref Number Merchant",
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON response body consistion of the corresponding periodic TARGET-2 payment initation JSON body together with an optional transaction status field.
{
"title": "periodicPaymentInitiationTarget2WithStatusResponse",
"type": "object",
"properties": {
"endToEndIdentification": {
"type": "string",
"maxLength": 35
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON response body consistion of the corresponding periodic cross-border payment initation JSON body together with an optional transaction status field.
{
"title": "periodicPaymentInitiationCrossBorderWithStatusResponse",
"type": "object",
"properties": {
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"instructedAmount": {
"$ref": "#\/definitions\/amount"
},
"creditorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"creditorAgent": {
"description": "BICFI",
"example": "AAAADEBBXXX",
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
},
"creditorName": {
"description": "Creditor Name",
"example": "Creditor Name",
"type": "string",
"maxLength": 70
},
"creditorAddress": {
"$ref": "#\/definitions\/address"
},
"remittanceInformationUnstructured": {
"type": "string",
"maxLength": 140
},
"startDate": {
"description": "The first applicable day of execution starting from this date is the first payment.",
"type": "string",
"format": "date"
},
"endDate": {
"description": "The last applicable day of execution If not given, it is an infinite standing order.",
"type": "string",
"format": "date"
},
"executionRule": {
"$ref": "#\/definitions\/executionRule"
},
"frequency": {
"$ref": "#\/definitions\/frequencyCode"
},
"dayOfExecution": {
"$ref": "#\/definitions\/dayOfExecution"
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
]
}
JSON response body consistion of the corresponding bulk SCT payment initation JSON body together with an optional transaction status field.
{
"title": "bulkPaymentInitiationSctWithStatusResponse",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. ",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for SCT payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationSct_json"
}
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON response body consistion of the corresponding bulk SCT INST payment initation JSON body together with an optional transaction status field.
{
"title": "bulkPaymentInitiationSctInstWithStatusResponse",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. The ASPSP will follow this preference according to contracts agreed on with the PSU.",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for SCT INST payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationSctInst_json"
}
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON response body consistion of the corresponding bulk TARGET-2 payment initation JSON body together with an optional transaction status field.
{
"title": "bulkPaymentInitiationTarget2WithStatusResponse",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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. ",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for TARGET-2 payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationTarget2_json"
}
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"payments"
]
}
JSON response body consistion of the corresponding bulk cross-border payment initation JSON body together with an optional transaction status field.
{
"title": "bulkPaymentInitiationCrossBorderWithStatusResponse",
"type": "object",
"properties": {
"batchBookingPreferred": {
"description": "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.",
"example": false,
"type": "boolean"
},
"requestedExecutionDate": {
"type": "string",
"format": "date"
},
"debtorAccount": {
"$ref": "#\/definitions\/accountReference"
},
"payments": {
"description": "A list of JSON bodies for cross-border payments.",
"type": "array",
"items": {
"$ref": "#\/definitions\/paymentInitiationCrossBorder_json"
}
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"debtorAccount",
"payments"
]
}
Body of the JSON response with SCA Status
{
"title": "scaStatusResponse",
"example": {
"description": "Response of an Update PSU Identification for a payment initiation request for the decoupled approach.",
"value": {
"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": {
"scaStatus": {
"href": "\/v1\/payments\/qwer3456tzui7890\/authorisations\/123auth456"
}
}
}
},
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
}
}
}
Body of the JSON response for a Start SCA authorisation request.
{
"title": "startScaprocessResponse",
"type": "object",
"properties": {
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "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.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus",
"_links"
]
}
Body of the JSON response for a successful update PSU Identification request.
{
"title": "updatePsuIdenticationResponse",
"type": "object",
"properties": {
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP. ",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"_links",
"scaStatus"
]
}
Body of the JSON response for a successful update PSU Authentication request.
{
"title": "updatePsuAuthenticationResponse",
"type": "object",
"properties": {
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. ",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus"
]
}
Body of the JSON response for a successful select PSU Authentication Method request.
{
"title": "selectPsuAuthenticationMethodResponse",
"type": "object",
"properties": {
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"scaStatus": {
"$ref": "#\/definitions\/scaStatus"
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
}
},
"required": [
"scaStatus"
]
}
Body of the JSON response for a successful get signing basket request.Only codes RCVD, ACTC, RJCT are used.
{
"title": "signingBasketResponse-200",
"type": "object",
"properties": {
"payments": {
"description": "A list of paymentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"consents": {
"description": "A list of consentIds",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
}
},
"required": [
"transactionStatus"
]
}
{
"title": "signingBasketStatusResponse-200",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus_SB"
}
},
"required": [
"transactionStatus"
]
}
Body of the JSON response for a successful create signing basket request.
{
"title": "signingBasketResponse-201",
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#\/definitions\/transactionStatus"
},
"basketId": {
"description": "Resource identification of the generated signing basket resource.",
"example": "1234-basket-567",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. ",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "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.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"psuMessage": {
"description": "Text to be displayed to the PSU",
"type": "string",
"maxLength": 512
},
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage2XX"
}
}
},
"required": [
"transactionStatus",
"basketId",
"_links"
]
}
Body of the JSON response for a successful conset request.
{
"title": "consentsResponse-201",
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
},
"consentId": {
"description": "ID of the corresponding consent object as returned by an Account Information Consent Request.",
"type": "string"
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. ",
"type": "array",
"items": {
"$ref": "#\/definitions\/authenticationObject"
}
},
"chosenScaMethod": {
"$ref": "#\/definitions\/authenticationObject"
},
"challengeData": {
"$ref": "#\/definitions\/challengeData"
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"message": {
"description": "Text to be displayed to the PSU, e.g. in a Decoupled SCA Approach.",
"type": "string",
"maxLength": 512
}
},
"required": [
"consentStatus",
"consentId",
"_links"
]
}
Body of the JSON response for a successful get status request for a consent.
{
"title": "consentStatusResponse-200",
"type": "object",
"properties": {
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"consentStatus"
]
}
Body of the JSON response for a successfull get consent request.
{
"title": "consentInformationResponse-200_json",
"type": "object",
"properties": {
"access": {
"$ref": "#\/definitions\/accountAccess"
},
"recurringIndicator": {
"description": "true, if the consent is for recurring access to the account data.false, if the consent is for one access to the account data.",
"example": false,
"type": "boolean"
},
"validUntil": {
"description": "This parameter is requesting a valid until date for the requested consent.",
"example": "2020-12-31",
"type": "string",
"format": "date"
},
"frequencyPerDay": {
"description": "This field indicates the requested maximum frequency for an access without PSU involvement per day. ",
"example": 4,
"type": "integer",
"format": "int32"
},
"lastActionDate": {
"description": "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.",
"example": "2018-07-01",
"type": "string",
"format": "date"
},
"consentStatus": {
"$ref": "#\/definitions\/consentStatus"
}
},
"required": [
"access",
"recurringIndicator",
"validUntil",
"frequencyPerDay",
"lastActionDate",
"consentStatus"
]
}
Body of the response for a successful read balance for an account request.
{
"title": "readAccountBalanceResponse-200",
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the response for a successful read balance for a card account request.
{
"title": "readCardAccountBalanceResponse-200",
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"balances": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
}
},
"required": [
"balances"
]
}
Body of the JSON response for a successful read transaction list request.This account report contains transactions resulting from the query parameters.
{
"title": "transactionsResponse-200_json",
"type": "object",
"properties": {
"account": {
"$ref": "#\/definitions\/accountReference"
},
"transactions": {
"$ref": "#\/definitions\/accountReport"
},
"balances": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
Body of the JSON response for a successful read card account transaction list request.
{
"title": "cardAccountsTransactionsResponse200",
"type": "object",
"properties": {
"cardAccount": {
"$ref": "#\/definitions\/accountReference"
},
"cardTransactions": {
"$ref": "#\/definitions\/cardAccountReport"
},
"balances": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#\/definitions\/balance"
}
},
"_links": {
"description": "A list of hyperlinks to be recognised by the TPP.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
A _link object with all availabel link types
{
"title": "_linksAll",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updatePsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithProprietaryData": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updateProprietaryData": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updatePsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updateEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"selectAuthenticationMethod": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithTransactionAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"authoriseTransaction": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"self": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"status": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"account": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"balances": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"transactions": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"transactionDetails": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"cardAccount": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"cardTransactions": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"first": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"next": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"previous": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"last": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"download": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksPaymentInitiation",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithTransactionAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"self": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"status": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
Type of links admitted in this response.
{
"title": "_linksPaymentInitiationMultiLevelSca",
"type": "object",
"properties": {
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"self": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"status": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksPaymentInitiationCancel",
"type": "object",
"properties": {
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksUpdatePsuIdentification",
"type": "object",
"properties": {
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU.
{
"title": "_linksUpdatePsuAuthentication",
"type": "object",
"properties": {
"selectAuthenticationMethod": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"authoriseTransaction": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksSelectPsuAuthenticationMethod",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updatePsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updatePsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"authoriseTransaction": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksStartScaProcess",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"updatePsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"selectAuthenticationMethod": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"authoriseTransaction": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksDownload",
"type": "object",
"properties": {
"download": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
},
"required": [
"download"
]
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksConsents",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithTransactionAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"self": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"status": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
A list of hyperlinks to be recognised by the TPP.
{
"title": "_linksSigningBasket",
"type": "object",
"properties": {
"scaRedirect": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaOAuth": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuIdentification": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"startAuthorisationWithTransactionAuthorisation": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"self": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"status": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"scaStatus": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
{
"title": "_linksAccountReport",
"type": "object",
"properties": {
"account": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"first": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"next": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"previous": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"last": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
},
"required": [
"account"
]
}
{
"title": "_linksCardAccountReport",
"type": "object",
"properties": {
"cardAccount": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"first": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"next": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"previous": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"last": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
},
"required": [
"cardAccount"
]
}
{
"title": "_linksTransactionDetails",
"type": "object",
"properties": {
"transactionDetails": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
},
"required": [
"transactionDetails"
]
}
Links to the account, which can be directly used for retrieving account information from this dedicated account.
{
"title": "_linksAccountDetails",
"type": "object",
"properties": {
"balances": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
},
"transactions": {
"description": "Link to a resource",
"example": "\/v1\/payments\/sepa-credit-transfers\/1234-wertiq-983",
"type": "string"
}
}
}
Category of the TPP message category
{
"title": "tppMessageCategory",
"example": "ERROR",
"type": "string"
}
Message codes for HTTP Error codes 2XX.
{
"title": "MessageCode2XX",
"example": "WARNING",
"type": "string"
}
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_AIS",
"example": "FORMAT_ERROR",
"type": "string"
}
Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_PIS",
"example": "FORMAT_ERROR",
"type": "string"
}
Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_PIIS",
"example": "FORMAT_ERROR",
"type": "string"
}
Message codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).
{
"title": "MessageCode400_SB",
"example": "FORMAT_ERROR",
"type": "string"
}
Message codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_PIS",
"example": "CERTIFICATE_INVALID",
"type": "string"
}
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_AIS",
"example": "CERTIFICATE_INVALID",
"type": "string"
}
Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_PIIS",
"example": "CERTIFICATE_INVALID",
"type": "string"
}
Message codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).
{
"title": "MessageCode401_SB",
"example": "CERTIFICATE_INVALID",
"type": "string"
}
Message codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_PIS",
"example": "CONSENT_UNKNOWN",
"type": "string"
}
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_AIS",
"example": "CONSENT_UNKNOWN",
"type": "string"
}
Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_PIIS",
"example": "CONSENT_UNKNOWN",
"type": "string"
}
Message codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).
{
"title": "MessageCode403_SB",
"example": "CONSENT_UNKNOWN",
"type": "string"
}
Message codes defined for PIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_PIS",
"example": "RESOURCE_UNKNOWN",
"type": "string"
}
Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_AIS",
"example": "RESOURCE_UNKNOWN",
"type": "string"
}
Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_PIIS",
"example": "RESOURCE_UNKNOWN",
"type": "string"
}
Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).
{
"title": "MessageCode404_SB",
"example": "RESOURCE_UNKNOWN",
"type": "string"
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIS",
"example": "SERVICE_INVALID",
"type": "string"
}
Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIS_CANC",
"example": "CANCELLATION_INVALID",
"type": "string",
"enum": [
"CANCELLATION_INVALID",
"SERVICE_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_AIS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_PIIS",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for SB for HTTP Error code 405 (METHOD NOT ALLOWED).
{
"title": "MessageCode405_SB",
"example": "SERVICE_INVALID",
"type": "string",
"enum": [
"SERVICE_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
{
"title": "MessageCode406_AIS",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"enum": [
"REQUESTED_FORMATS_INVALID"
]
}
Message codes defined for AIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_AIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for PIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_PIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_PIIS",
"example": "STATUS_INVALID",
"type": "string",
"enum": [
"STATUS_INVALID"
]
}
Message codes defined for signing baskets for HTTP Error code 409 (CONFLICT).
{
"title": "MessageCode409_SB",
"example": "REFERENCE_STATUS_INVALID",
"type": "string",
"enum": [
"REFERENCE_STATUS_INVALID",
"STATUS_INVALID"
]
}
Message codes for HTTP Error code 429 (TOO MANY REQUESTS).
{
"title": "MessageCode429_AIS",
"example": "ACCESS_EXCEEDED",
"type": "string",
"enum": [
"ACCESS_EXCEEDED"
]
}
{
"title": "tppMessage2XX",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error codes 2XX.",
"example": "WARNING",
"type": "string",
"default": "WARNING"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage400_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SB"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage401_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SB"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage403_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SB"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage404_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIS_CANC",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage405_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for SB for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_PIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage406_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_PIIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage409_SB",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SB"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
{
"title": "tppMessage429_AIS",
"type": "object",
"properties": {
"category": {
"$ref": "#\/definitions\/tppMessageCategory"
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"path": {
"type": "string"
},
"text": {
"description": "Additional explaining text to the TPP.",
"type": "string",
"maxLength": 512
}
},
"required": [
"category",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIS.
{
"title": "Error400_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. Could be in local language. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks. Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for AIS.
{
"title": "Error400_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError1"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for PIIS.
{
"title": "Error400_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError2"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 400 for signing baskets.
{
"title": "Error400_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SB"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError3"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIS.
{
"title": "Error401_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError4"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for AIS.
{
"title": "Error401_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError5"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for PIIS.
{
"title": "Error401_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError6"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 401 for signing baskets.
{
"title": "Error401_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SB"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError7"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIS.
{
"title": "Error403_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError8"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for AIS.
{
"title": "Error403_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError9"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for PIIS.
{
"title": "Error403_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError10"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 403 for signing baskets.
{
"title": "Error403_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SB"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError11"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIS.
{
"title": "Error404_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError12"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for AIS.
{
"title": "Error404_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError13"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for PIIS.
{
"title": "Error404_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError14"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 404 for signing baskets.
{
"title": "Error404_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError15"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIS.
{
"title": "Error405_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError16"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for a pament cancelation (PIS).
{
"title": "Error405_PIS_CANC",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError17"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for AIS.
{
"title": "Error405_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError18"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for PIIS.
{
"title": "Error405_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError19"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 405 for signing baskets.
{
"title": "Error405_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for SB for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError20"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 406 for AIS.
{
"title": "Error406_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError21"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIS.
{
"title": "Error409_PIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError22"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for AIS.
{
"title": "Error409_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError23"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for PIIS.
{
"title": "Error409_PIIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError24"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 409 for signing baskets.
{
"title": "Error409_SB",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SB"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError25"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
Standardised definition of reporting error information according to [RFC7807] in case of a HTTP error code 429 for AIS.
{
"title": "Error429_AIS",
"type": "object",
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. ",
"type": "string",
"maxLength": 70
},
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
},
"additionalErrors": {
"description": "Array of Error Information Blocks.Might be used if more than one error is to be communicated",
"type": "array",
"items": {
"$ref": "#\/definitions\/AdditionalError26"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"required": [
"type",
"code"
]
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 400.
{
"title": "Error400_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage400_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error401_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage401_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 403.
{
"title": "Error403_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage403_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 404.
{
"title": "Error404_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage404_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIS_CANC",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIS_CANC"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 401.
{
"title": "Error405_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage405_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 406.
{
"title": "Error406_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage406_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_PIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_PIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_PIIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_PIIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 409.
{
"title": "Error409_NG_SB",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage409_SB"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
NextGenPSD2 specific definition of reporting error information in case of a HTTP error code 429.
{
"title": "Error429_NG_AIS",
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/tppMessage429_AIS"
}
},
"_links": {
"description": "A _link object with all availabel link types",
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError1",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError2",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError3",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode400_SB"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError4",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError5",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError6",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError7",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode401_SB"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError8",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError9",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_AIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError10",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_PIIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError11",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode403_SB"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError12",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode404_PIS"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError13",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError14",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError15",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).",
"example": "RESOURCE_UNKNOWN",
"type": "string",
"default": "RESOURCE_UNKNOWN"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError16",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for payment cancelations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError17",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode405_PIS_CANC"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError18",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError19",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError20",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for SB for HTTP Error code 405 (METHOD NOT ALLOWED).",
"example": "SERVICE_INVALID",
"type": "string",
"default": "SERVICE_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError21",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).",
"example": "REQUESTED_FORMATS_INVALID",
"type": "string",
"default": "REQUESTED_FORMATS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError22",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError23",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for AIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError24",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).",
"example": "STATUS_INVALID",
"type": "string",
"default": "STATUS_INVALID"
}
},
"required": [
"code"
]
}
This is a data element to support the declaration of additional errors in the context of [RFC7807].
{
"title": "AdditionalError25",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"$ref": "#\/definitions\/MessageCode409_SB"
}
},
"required": [
"code"
]
}
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": "AdditionalError26",
"type": "object",
"properties": {
"title": {
"description": "Short human readable description of error type. ",
"type": "string",
"maxLength": 70
},
"detail": {
"description": "Detailed human readable text specific to this instance of the error. ",
"type": "string",
"maxLength": 512
},
"code": {
"description": "Message codes for HTTP Error code 429 (TOO MANY REQUESTS).",
"example": "ACCESS_EXCEEDED",
"type": "string",
"default": "ACCESS_EXCEEDED"
}
},
"required": [
"code"
]
}
Optional if supported by API provider.Only the value allAccounts is admitted.
{
"title": "AllPsd2",
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts"
]
}
Optional if supported by API provider.Only the values allAccounts or allAccountsWithBalances is admitted.
{
"title": "AvailableAccounts",
"example": "allAccounts",
"type": "string",
"enum": [
"allAccounts",
"allAccountsWithBalances"
]
}
{
"title": "bookingStatus",
"example": "booked",
"type": "string",
"enum": [
"booked",
"pending",
"both"
]
}
The format type of the OTP to be typed in. The admitted values are characters or integer.
{
"title": "OtpFormat",
"example": "characters",
"type": "string",
"enum": [
"characters",
"integer"
]
}
{
"title": "payment-product",
"example": "sepa-credit-transfers",
"type": "string",
"enum": [
"sepa-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments",
"cross-border-credit-transfers",
"pain.001-sepa-credit-transfers",
"pain.001-instant-sepa-credit-transfers",
"pain.001-target-2-payments",
"pain.001-cross-border-credit-transfers"
]
}
{
"title": "payment-service",
"example": "payments",
"type": "string",
"enum": [
"payments",
"bulk-payments",
"periodic-payments"
]
}
{
"title": "PSU-Http-Method",
"example": "GET",
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
}
{
"title": "TPP-Explicit-Authorisation-Preferred",
"example": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
{
"title": "TPP-Redirect-Preferred",
"example": "true",
"type": "string",
"enum": [
"true",
"false"
]
}
Specifies the usage of the account PRIV: private personal account ORGA: professional account
{
"title": "Usage",
"example": "PRIV",
"type": "string",
"enum": [
"PRIV",
"ORGA"
]
}
Equals true if sufficient funds are available at the time of the request, false otherwise.
{
"type": "object",
"properties": {
"fundsAvailable": {
"type": "boolean"
}
},
"required": [
"fundsAvailable"
]
}