| Class | Description |
|---|---|
| AccountAccess |
Requested access services for a consent.
|
| AccountDetails |
The ASPSP shall give at least one of the account reference identifiers: - iban - bban - pan - maskedPan - msisdn If the account is a multicurrency account currency code in \"currency\" is set to \"XXX\".
|
| AccountId |
This identification is denoting the addressed account, where the transaction has been performed.
|
| AccountList |
List of accounts with details.
|
| AccountReferenceBban |
Reference to an Account.
|
| AccountReferenceIban |
Reference to an account by the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.
|
| AccountReferenceMaskedPan |
Reference to an account by the Primary Account Number (PAN) of a card in a masked form.
|
| AccountReferenceMsisdn |
An alias to access a payment account via a registered mobile phone number.
|
| AccountReferencePan |
Reference to an account by the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.
|
| AccountReport |
JSON based account report.
|
| Address |
Address
|
| Amount |
Amount
|
| AmountValue |
The amount given with fractional digits, where fractions must be compliant to the currency definition.
|
| AuthenticationMethodId |
An identification provided by the ASPSP for the later identification of the authentication method selection.
|
| AuthenticationObject |
Authentication Object
|
| AuthorisationId |
Resource identification of the related SCA
|
| Authorisations |
An array of all authorisationIds
|
| AuthorisationsList |
An array of all authorisationIds
|
| Balance |
A single balance element
|
| BalanceList |
A list of balances regarding this account, e.g.
|
| BankTransactionCode |
Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.
|
| BasketId |
Resource identification of the generated signing basket resource.
|
| BatchBookingPreferred |
If this element equals 'true', the PSU prefers only one booking entry.
|
| Bban |
Basic Bank Account Number (BBAN) Identifier This data element can be used in the body of the Consent Request Message for retrieving Account access Consent from this Account.
|
| Bicfi |
BICFI
|
| BookingDate |
The Date when an entry is posted to an account on the ASPSPs books.
|
| BulkPaymentInitiationCrossBorderJson |
JSON body for a bulk cross-border payment initation.
|
| BulkPaymentInitiationCrossBorderWithStatusResponse |
JSON response body consistion of the corresponding bulk cross-border payment initation JSON body together with an optional transaction status field.
|
| BulkPaymentInitiationSctInstJson |
JSON Body for a bulk SCT INST payment initation.
|
| BulkPaymentInitiationSctInstWithStatusResponse |
JSON response body consistion of the corresponding bulk SCT INST payment initation JSON body together with an optional transaction status field.
|
| BulkPaymentInitiationSctJson |
JSON Body for a bulk SCT payment initation.
|
| BulkPaymentInitiationSctWithStatusResponse |
JSON response body consistion of the corresponding bulk SCT payment initation JSON body together with an optional transaction status field.
|
| BulkPaymentInitiationTarget2Json |
JSON Body for a bulk TARGET-2 payment initation.
|
| BulkPaymentInitiationTarget2WithStatusResponse |
JSON response body consistion of the corresponding bulk TARGET-2 payment initation JSON body together with an optional transaction status field.
|
| Camt052 |
camt.052 XML message
|
| Camt053 |
camt.053 XML message
|
| Camt054 |
camt.054 XML message
|
| CancellationId |
Identification for cancellation resource
|
| CancellationList |
An array of all cancellationIds connected to this resource.
|
| CashAccountType |
ExternalCashAccountType1Code from ISO 20022.
|
| ChallengeData |
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.
|
| ChosenScaMethod |
ChosenScaMethod
|
| CombinedServiceIndicator |
If \"true\" indicates that a payment initiation service will be addressed in the same \"session\".
|
| ConfirmationOfFunds |
JSON Request body for the \"Confirmation of Funds Service\" <table> <tr> <td>cardNumber</td> <td>String </td> <td>Optional</td> <td>Card Number of the card issued by the PIISP.
|
| ConsentId |
ID of the corresponding consent object as returned by an Account Information Consent Request.
|
| ConsentIdList |
A list of consentIds
|
| ConsentInformationResponse200Json |
Body of the JSON response for a successfull get consent request.
|
| Consents |
Content of the body of a consent request.
|
| ConsentsResponse201 |
Body of the JSON response for a successful conset request.
|
| ConsentStatusResponse200 |
Body of the JSON response for a successful get status request for a consent.
|
| CountryCode |
ISO 3166 ALPHA2 country code
|
| CreditorName |
Creditor Name
|
| CurrencyCode |
ISO 4217 Alpha 3 currency code
|
| DebtorName |
Debtor Name
|
| EndDate |
The last applicable day of execution If not given, it is an infinite standing order.
|
| EntryReference |
Is the identification of the transaction as used e.g.
|
| ExchangeRate |
Exchange Rate
|
| ExchangeRateList |
Array of exchange rates
|
| FrequencyPerDay |
This field indicates the requested maximum frequency for an access per day.
|
| HrefType |
Link to a resource
|
| Iban |
IBAN of an account
|
| InlineResponse200 |
Equals \"true\" if sufficient funds are available at the time of the request, \"false\" otherwise.
|
| LastActionDate |
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.
|
| LinksAccountDetails |
Links to the account, which can be directly used for retrieving account information from this dedicated account.
|
| LinksAccountReport |
LinksAccountReport
|
| LinksConsents |
A list of hyperlinks to be recognised by the TPP.
|
| LinksDownload |
A list of hyperlinks to be recognised by the TPP.
|
| LinksPaymentInitiation |
A list of hyperlinks to be recognised by the TPP.
|
| LinksPaymentInitiationCancel |
A list of hyperlinks to be recognised by the TPP.
|
| LinksPaymentInitiationMultiLevelSca |
Type of links admitted in this response, (further links might be added for ASPSP defined extensions): * 'startAuthorisation': In case, where an explicit start of the transaction authorisation is needed, but no more data needs to be updated (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
|
| LinksSelectPsuAuthenticationMethod |
A list of hyperlinks to be recognised by the TPP.
|
| LinksSigningBasket |
A list of hyperlinks to be recognised by the TPP.
|
| LinksStartScaProcess |
A list of hyperlinks to be recognised by the TPP.
|
| LinksTransactionDetails |
LinksTransactionDetails
|
| LinksUpdatePsuAuthentication |
A list of hyperlinks to be recognised by the TPP.
|
| LinksUpdatePsuIdentification |
A list of hyperlinks to be recognised by the TPP.
|
| MaskedPan |
Masked Primary Account Number
|
| Msisdn |
Mobile phone number.
|
| Mt940 |
Data MT940 format in a text structure.
|
| Mt942 |
Data MT942 format in a text structure.
|
| Pan |
Primary Account Number according to ISO/IEC 7812.
|
| PaymentId |
Resource identification of the generated payment initiation resource.
|
| PaymentIdList |
A list of paymentIds
|
| PaymentInitationRequestMultiLevelScaResponse201 |
Body of the response for a successful payment initiation request.
|
| PaymentInitationRequestResponse201 |
Body of the response for a successful payment initiation request.
|
| PaymentInitiationCancelResponse200202 |
Body of the response for a successful cancel payment request.
|
| PaymentInitiationCrossBorderBulkElementJson |
JSON body for a cross-border payment initation.
|
| PaymentInitiationCrossBorderJson |
JSON body for a cross-border payment initation.
|
| PaymentInitiationCrossBorderPain001 |
A pain.001 structure corresponding to the cross-border schema For cross-border payments only community wide pain.001 schemes do exist.
|
| PaymentInitiationCrossBorderWithStatusResponse |
JSON response body consistion of the corresponding cross-border payment initation JSON body together with an optional transaction status field.
|
| PaymentInitiationSctBulkElementJson |
Body for a bulk SCT payment initation.
|
| PaymentInitiationSctInstBulkElementJson |
Body for a SCT INST payment initation.
|
| PaymentInitiationSctInstJson |
Body for a SCT INST payment initation.
|
| PaymentInitiationSctInstPain001 |
A pain.001 structure corresponding to the SCT INST schema.
|
| PaymentInitiationSctInstWithStatusResponse |
JSON response body consistion of the corresponding SCT INST payment initation JSON body together with an optional transaction status field.
|
| PaymentInitiationSctJson |
Body for a SCT payment initation.
|
| PaymentInitiationSctPain001 |
A pain.001 structure corresponding to the SCT schema urn:iso:std:iso:20022:tech:xsd:pain.001.001.03
|
| PaymentInitiationSctWithStatusResponse |
JSON response body consistion of the corresponding SCT payment initation JSON body together with an optional transaction status field.
|
| PaymentInitiationStatusResponse200Json |
Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
|
| PaymentInitiationStatusResponse200Xml |
Body of the response for a successful payment initiation status request in case of an XML based endpoint.
|
| PaymentInitiationTarget2BulkElementJson |
Body for a bulk TARGET-2 payment initation.
|
| PaymentInitiationTarget2Json |
Body for a TARGET-2 payment initation.
|
| PaymentInitiationTarget2Pain001 |
A pain.001 structure corresponding to the target-2 schema For TARGET-2 payments only community wide pain.001 schemes do exist.
|
| PaymentInitiationTarget2WithStatusResponse |
JSON response body consistion of the corresponding TARGET-2 payment initation JSON body together with an optional transaction status field.
|
| PeriodicPaymentInitiationCrossBorderJson |
JSON body for a periodic cross-border payment initation.
|
| PeriodicPaymentInitiationCrossBorderWithStatusResponse |
JSON response body consistion of the corresponding periodic cross-border payment initation JSON body together with an optional transaction status field.
|
| PeriodicPaymentInitiationMultipartBody |
The multipart message definition for the initiation of a periodic payment initiation where the information of the payment is contained in an pain.001 message (Part 1) and the additional informations related to the periodic payment is an additional JSON message (Part 2).
|
| PeriodicPaymentInitiationSctInstJson |
JSON Body for a periodic SCT INST payment initation.
|
| PeriodicPaymentInitiationSctInstWithStatusResponse |
JSON response body consistion of the corresponding periodic SCT INST payment initation JSON body together with an optional transaction status field.
|
| PeriodicPaymentInitiationSctJson |
JSON Body for a periodic SCT payment initation.
|
| PeriodicPaymentInitiationSctWithStatusResponse |
JSON response body consistion of the corresponding periodic SCT payment initation JSON body together with an optional transaction status field.
|
| PeriodicPaymentInitiationTarget2Json |
JSON Body for a periodic target-2 payment initation.
|
| PeriodicPaymentInitiationTarget2WithStatusResponse |
JSON response body consistion of the corresponding periodic TARGET-2 payment initation JSON body together with an optional transaction status field.
|
| PeriodicPaymentInitiationXmlPart2StandingorderTypeJson |
The body part 2 of a periodic payment initation request containes the execution related informations of the periodic payment.
|
| ProprietaryBankTransactionCode |
Proprietary bank transaction code as used within a community or within an ASPSP e.g.
|
| PsuData |
PSU Data for Update PSU Authentication.
|
| PsuMessageText |
Text to be displayed to the PSU
|
| ReadBalanceResponse200 |
Body of the response for a successful read balance request.
|
| RecurringIndicator |
\"true\", if the consent is for recurring access to the account data.
|
| RemittanceInformationStructured |
Structured remittance information
|
| RemittanceInformationUnstructured |
Unstructured remittance information
|
| ResourceId |
This identification is given by the attribute resourceId of the corresponding entry of a transaction list.
|
| ScaAuthenticationData |
SCA authentication data, depending on the chosen authentication method.
|
| ScaMethods |
This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.
|
| ScaStatusResponse |
Body of the JSON response with SCA Status
|
| SelectPsuAuthenticationMethod |
Content of the body of a Select PSU Authentication Method Request
|
| SelectPsuAuthenticationMethodResponse |
Body of the JSON response for a successful select PSU Authentication Method request.
|
| SigningBasket |
JSON Body of a establish signing basket request
|
| SigningBasketResponse200 |
Body of the JSON response for a successful get signing basket request.
|
| SigningBasketResponse201 |
Body of the JSON response for a successful create signing basket request.
|
| StartDate |
The first applicable day of execution starting from this date is the first payment.
|
| StartScaprocessResponse |
Body of the JSON response for a Start SCA authorisation request.
|
| TppMessageAISACCESSEXCEEDED429 |
Message to the TPP: The access on the account has been exceeding the consented multiplicity per day.
|
| TppMessageAISCONSENTINVALID401 |
The consent definition is not complete or invalid.
|
| TppMessageAISREQUESTEDFORMATSINVALID406 |
Message to the TPP: The requested formats in the Accept header entry are not matching the formats offered by the ASPSP.
|
| TppMessageAISSESSIONSNOTSUPPORTED400 |
The combined service flag may not be used with this ASPSP.
|
| TppMessageGeneric |
One Message to the TPP on operational issues.
|
| TppMessageGENERICCERTIFICATEBLOCKED401 |
Signature/corporate seal certificate has been blocked by the ASPSP.
|
| TppMessageGENERICCERTIFICATEEXPIRED401 |
Signature/corporate seal certificate is expired.
|
| TppMessageGENERICCERTIFICATEINVALID401 |
The contents of the signature/corporate seal certificate are not matching PSD2 general PSD2 or attribute requirements.
|
| TppMessageGENERICCERTIFICATEMISSING401 |
Signature/corporate seal certificate was not available in the request but is mandated for the corresponding.
|
| TppMessageGENERICCERTIFICATEREVOKED401 |
Signature/corporate seal certificate has been revoked by QSTP.
|
| TppMessageGENERICCONSENTEXPIRED401 |
The consent was created by this TPP but has expired and needs to be renewed.
|
| TppMessageGENERICCONSENTINVALID401 |
The consent was created by this TPP but is not valid for the addressed service/resource.
|
| TppMessageGENERICCONSENTUNKNOWN403400 |
The Consent-ID cannot be matched by the ASPSP relative to the TPP.
|
| TppMessageGENERICCORPORATEIDINVALID401 |
The PSU-Corporate-ID cannot be matched by the addressed ASPSP.
|
| TppMessageGENERICFORMATERROR400 |
Format of certain request fields are not matching the XS2A requirements.
|
| TppMessageGENERICPARAMETERNOTSUPPORTED400 |
The parameter is not supported by the API provider.
|
| TppMessageGENERICPERIODINVALID400 |
Requested time period out of bound.
|
| TppMessageGENERICPSUCREDENTIALSINVALID401 |
The PSU-ID cannot be matched by the addressed ASPSP or is blocked, or a password resp.
|
| TppMessageGENERICRESOURCEEXPIRED403400 |
The addressed resource is associated with the TPP but has expired, not addressable anymore.
|
| TppMessageGENERICRESOURCEUNKNOWN404403400 |
The addressed resource is unknown relative to the TPP.
|
| TppMessageGENERICSCAMETHODUNKNOWN400 |
Addressed SCA method in the Authentication Method Select Request is unknown or cannot be matched by the ASPSP with the PSU.
|
| TppMessageGENERICSERVICEBLOCKED403 |
This service is not reachable for the addressed PSU due to a channel independent blocking by the ASPSP.
|
| TppMessageGENERICSERVICEINVALID400405 |
Message to the TPP: The addressed service is not valid for the addressed resources or the submitted data.
|
| TppMessageGENERICSIGNATUREINVALID401 |
Application layer eIDAS Signature for TPP authentication is not correct.
|
| TppMessageGENERICSIGNATUREMISSING401 |
Application layer eIDAS Signature for TPP authentication is mandated by the ASPSP but is missing.
|
| TppMessageGENERICTIMESTAMPINVALID400 |
Timestamp not in accepted time period.
|
| TppMessageGENERICTOKENEXPIRED401 |
The OAuth2 token is associated to the TPP but has expired and needs to be renewed.
|
| TppMessageGENERICTOKENINVALID401 |
The OAuth2 token is associated to the TPP but is not valid for the addressed service/resource.
|
| TppMessageGENERICTOKENUNKNOWN401 |
The OAuth2 token cannot be matched by the ASPSP relative to the TPP.
|
| TppMessagePIISCARDINVALID400 |
Addressed card number is unknown to the ASPSP or not associated to the PSU.
|
| TppMessagePIISNOPIISACTIVATION400 |
The PSU has not activated the addressed account for the usage of the PIIS associated with the TPP.
|
| TppMessagePISEXECUTIONDATEINVALID400 |
The requested execution date is not a valid execution date for the ASPSP.
|
| TppMessagePISPAYMENTFAILED400 |
The payment initiation POST request failed during the initial process.
|
| TppMessagePISPRODUCTINVALID403 |
The addressed payment product is not available for the PSU.
|
| TppMessagePISPRODUCTUNKNOWN404 |
The addressed payment product is not supported by the ASPSP.
|
| TppMessagePISREQUIREDKIDMISSING401 |
The payment initiation has failed due to a missing KID.
|
| TppMessages |
Messages to the TPP on operational issues.
|
| TppMessages400 |
Messages to the TPP on operational issues.
|
| TppMessages401 |
Messages with HTTP error code 401 to the TPP on operational issues.
|
| TppMessages403 |
Messages with HTTP error code 403 to the TPP on operational issues.
|
| TppMessages404 |
Messages with HTTP error code 404 to the TPP on operational issues.
|
| TppMessages405 |
Messages with HTTP error code 405 to the TPP on operational issues.
|
| TppMessages406 |
Messages with HTTP error code 406 to the TPP on operational issues.
|
| TppMessages429 |
Messages with HTTP error code 429 to the TPP on operational issues.
|
| TppMessageText |
Additional explaining text to the TPP.
|
| TransactionAuthorisation |
Content of the body of a Transaction Authorisation Request
|
| TransactionDate |
Date of the actual card transaction
|
| TransactionDetails |
Transaction details
|
| TransactionFeeIndicator |
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.
|
| TransactionList |
Array of transaction details
|
| TransactionsResponse200Json |
Body of the JSON response for a successful read transaction list request.
|
| UltimateCreditor |
Ultimate Creditor
|
| UltimateDebtor |
Ultimate Debtor
|
| UpdatePsuAuthentication |
Content of the body of a Update PSU Authentication Request Password subfield is used.
|
| UpdatePsuAuthenticationResponse |
Body of the JSON response for a successful update PSU Authentication request.
|
| UpdatePsuIdenticationResponse |
Body of the JSON response for a successful update PSU Identification request.
|
| ValidUntil |
This parameter is requesting a valid until date for the requested consent.
|
Copyright © 2018 Pivotal Software, Inc.. All rights reserved.