Schemas
obpStatusResponse
pageTitleTitle of the status page.
Incidents currently affecting the platform or its supported banks. Empty if there are none.
Maintenance windows currently in progress. Empty if there are none.
Upcoming planned maintenance windows. Empty if there are none.
pageUrlPublic URL of the status page.
statusPageEvent
idUnique ID of the incident or maintenance.
nameTitle of the incident or maintenance.
urlLink to the incident or maintenance on the status page.
lastUpdatedAtUTC timestamp of the latest update.
Components affected by the incident or maintenance.
lastUpdateMessageText of the latest update.
statusPageIncident
idUnique ID of the incident or maintenance.
nameTitle of the incident or maintenance.
urlLink to the incident or maintenance on the status page.
lastUpdatedAtUTC timestamp of the latest update.
Components affected by the incident or maintenance.
statusCurrent stage of the incident.
currentWorstImpactThe most severe impact currently caused by the incident.
lastUpdateMessageText of the latest update.
statusPageInProgressMaintenance
idUnique ID of the incident or maintenance.
nameTitle of the incident or maintenance.
urlLink to the incident or maintenance on the status page.
lastUpdatedAtUTC timestamp of the latest update.
Components affected by the incident or maintenance.
statusstartedAtUTC timestamp when the maintenance started.
scheduledEndAtUTC timestamp when the maintenance is scheduled to end.
lastUpdateMessageText of the latest update.
statusPageScheduledMaintenance
idUnique ID of the incident or maintenance.
nameTitle of the incident or maintenance.
urlLink to the incident or maintenance on the status page.
lastUpdatedAtUTC timestamp of the latest update.
Components affected by the incident or maintenance.
statusstartsAtUTC timestamp when the maintenance is scheduled to start.
endsAtUTC timestamp when the maintenance is scheduled to end.
lastUpdateMessageText of the latest update.
statusPageComponent
idUnique ID of the component.
nameName of the component.
currentStatusCurrent status of the component.
groupNameName of the group the component belongs to, if any.
sepaDirectDebitWithStatusResponse
requestedExecutionDateDate when payment is scheduled to be collected in ISO-Date Format, e.g. 2020-10-30.
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorId^[A-Z]{2}\d{2}[A-Z0-… · requiredA unique identifier assigned to the creditor authorising them to initiate SEPA Direct Debit collections.
localInstrumentCodeLocal instrument code. See Statuses & Types documentation for full descriptions of values.
sequenceTypeSequence type for SEPA Direct Debit collections. See Statuses & Types documentation for full descriptions of values.
Mandate information that authorises the SEPA Direct Debit.
debtorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
debtorNameDebtor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
instructionIdInstruction Id – identification for end-to-end processing.
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
chargeBearerCharge Bearer. ChargeBearerType1Code from ISO20022
ultimateCreditorName^[A-Za-z0-9 ]{1,70}$Ultimate Creditor Name
debtorAgentNameDebtor Agent Name
ultimateDebtorName^[A-Za-z0-9 ]{1,70}$Ultimate Debtor Name
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
remittanceInformationUnstructuredArrayArray of unstructured remittance information
Array of structured remittance information elements.
Up to 10 regulatory reporting items.
vopParty
name^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
vopPartyAccount
iban[A-Z]{2,2}[0-9]{2,2}… · requiredInternational Bank Account Number (IBAN) of an account.
verificationOfPayee_json
The registered name for the account.
The IBAN of the account.
partyAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
bulkVerificationOfPayee_json
verificationOfPayeeResponse
partyNameMatchThe match result of the VoP request in a 4-letter code. See Statuses & Types documentation for full descriptions of values.
matchedNameThe actual name found for the account. This is returned in case of a slight mismatch with the name provided in the request.
bulkVerificationOfPayeeResponse
bulkVerificationOfPayeeResponseItem
uetrUnique reference identifying the party verification request.
partyNameMatchThe match result of the VoP request in a 4-letter code. See Statuses & Types documentation for full descriptions of values.
matchedNameThe actual name found for the account. This is returned in case of a slight mismatch with the name provided in the request.
tppMessage200_VoP
categoryCategory of the TPP message category
codeMessage codes defined for Verification of Payee when the result is not a perfect match.
textAdditional explaining text to the TPP.
MessageCode200_VoP
Message codes defined for Verification of Payee when the result is not a perfect match.
confirmCrossBorderPaymentIntentResponse
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$Creditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorAddress[A-Z]{2}ISO 3166 ALPHA2 country code
remittanceInformationUnstructuredUnstructured remittance information
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
lastTransactionEnrichmentDateTime
The local date time of the latest ISO transaction enrichment, if enabled.
lastTransactionEnrichmentDateTimeUtc
The UTC date time of the latest ISO transaction enrichment, if enabled.
lastBalanceEnrichmentDateTime
The local date time of the latest ISO balance enrichment, if enabled.
lastBalanceEnrichmentDateTimeUtc
The UTC date time of the latest ISO balance enrichment, if enabled.
ConfirmIsoPaymentRequest
paymentIdsbatchBookingPreferredCreatePayoutRequest
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to a Swedish Bankgiro or Plusgiro account
creditorNameinstructionIdcreditorAgentrequestedExecutionDatedebtorAccountMessagecreditorAccountMessageinvoiceRefocrRefendToEndIdentificationCreatePayoutResponse
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
transactionFeeIndicatorAuthentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
psuMessagepayoutIdgiroWithName
giroNumber[0-9-]{5,35} · requiredSwedish Bankgiro or Plusgiro number
giroTypeSwedish giro type
nameName of the account as defined by the PSU within online channels.
GetPayoutResponse
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorNameReference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
endToEndIdentificationcreditorAgent[A-Z]{6,6}[A-Z2-9][A…remittanceInformationUnstructuredStructured remittance information
debtorAccountMessagecreditorAccountMessagerequestedExecutionDatetransactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
ProblemDetails
typetitlestatusdetailinstancegetKycStatusResponse
psuCorporateIdkycStatuskycValidUntilStartNewKycInstanceResponse
kycUrlkycUrl
clearingNumber
[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
accountNumber
[a-zA-Z0-9]{1,30}Bank account number. Used to identify the particular customer account within the financial institution.
paymentId
ID of the generated payment initiation resource. Only available for transactions generated via the Open Banking Platform.
paymentIdList
A list of paymentIds.
basketId
ID of the generated signing basket resource.
authorisationId
Resource identification of the related SCA
authenticationMethodId
An identification provided by the ASPSP for the later identification of the authentication method selection.
accountId
This identification is denoting the addressed account, where the transaction has been performed.
consentId
ID of the corresponding consent object as returned by an Account Information Consent Request.
consentIdList
A list of consentIds
transactionId
This identification is given by the attribute transactionId of the corresponding entry of a transaction list.
cancellationId
Identification for cancellation resource
entryReference
ID of the transaction as used e.g. for reference for deltafunction on application level.
transactionStatus
Uses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
transactionStatus_SBS
Uses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
scaStatus
Contains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
scaAuthenticationData
SCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded.
consentStatus
Overall lifecycle status of the consent. See Statuses & Types documentation for full descriptions of values.
transactionFee
ChargeBearerCharge Bearer. ChargeBearerType1Code from ISO20022
transactionFees
Array of transaction fees
ChargeBearerCharge Bearer. ChargeBearerType1Code from ISO20022
transactionFeeIndicator
If "true", the transaction will involve specific transaction costs as shown by the ASPSP in their public price list or as agreed between the ASPSP and PSU. If "false", the transaction will not involve additional specific transaction costs to the PSU.
recurringIndicator
If "true", the consent is for recurring access to the account data. If "false", the consent is for one-off access to the account data.
combinedServiceIndicator
If "true", indicates that a payment initiation service will be addressed in the same "session".
batchBookingPreferred
If "true", the PSU prefers only one booking entry. If "false", the PSU prefers individual booking of all included individual transactions. The ASPSP will follow this preference according to contracts agreed with the PSU.
scaMethods
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
authenticationTypeType of the authentication method. See Statuses & Types for full descriptions of values.
authenticationMethodIdAn identification provided by the ASPSP for the later identification of the authentication method selection.
authenticationVersionSpecifies the version of the authentication method. Useful when multiple tools exist under the same method type.
nameA user-defined or bank-provided label for the authentication method (e.g. "SMS OTP on phone +49160 xxxxx 28"). This should be shown to the user when offering authentication method choices.
explanationDetailed information about the SCA method for the PSU.
chosenScaMethod
authenticationTypeType of the authentication method. See Statuses & Types for full descriptions of values.
authenticationMethodIdAn identification provided by the ASPSP for the later identification of the authentication method selection.
authenticationVersionSpecifies the version of the authentication method. Useful when multiple tools exist under the same method type.
nameA user-defined or bank-provided label for the authentication method (e.g. "SMS OTP on phone +49160 xxxxx 28"). This should be shown to the user when offering authentication method choices.
explanationDetailed information about the SCA method for the PSU.
authenticationType
Type of the authentication method. See Statuses & Types for full descriptions of values.
authenticationObject
authenticationTypeType of the authentication method. See Statuses & Types for full descriptions of values.
authenticationMethodIdAn identification provided by the ASPSP for the later identification of the authentication method selection.
authenticationVersionSpecifies the version of the authentication method. Useful when multiple tools exist under the same method type.
nameA user-defined or bank-provided label for the authentication method (e.g. "SMS OTP on phone +49160 xxxxx 28"). This should be shown to the user when offering authentication method choices.
explanationDetailed information about the SCA method for the PSU.
signingBasket
paymentIdsA list of paymentIds.
challengeData
imagePNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.
dataChallenge data
imageLinkA link where the ASPSP will provides the challenge image for the TPP.
otpMaxLengthThe maximal length for the OTP to be typed in by the PSU.
otpFormatThe format type of the OTP to be typed in. The admitted values are "characters" or "integer".
additionalInformationAdditional 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.
hrefType
hrefLink to a resource
authorisations
authorisationIdsAn array of all authorisationIds
accountReference
iban[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
bban[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
accountNumber[a-zA-Z0-9]{1,30}Bank account number. Used to identify the particular customer account within the financial institution.
panPrimary Account Number according to ISO/IEC 7812.
maskedPanMasked Primary Account Number.
msisdnMobile phone number.
currency[A-Z]{3}ISO 4217 Alpha 3 currency code.
accountReferenceWithGiro
iban[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
bban[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
accountNumber[a-zA-Z0-9]{1,30}Bank account number. Used to identify the particular customer account within the financial institution.
panPrimary Account Number according to ISO/IEC 7812.
maskedPanMasked Primary Account Number.
msisdnMobile phone number.
bankgiroNumber[0-9-]{5,35}Swedish Bankgiro number
plusgiroNumber[0-9-]{5,35}Swedish Plusgiro number
currency[A-Z]{3}ISO 4217 Alpha 3 currency code.
trnsCreditorAccountReference
iban[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
bban[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
panPrimary Account Number according to ISO/IEC 7812.
maskedPanMasked Primary Account Number.
msisdnMobile phone number.
currency[A-Z]{3}ISO 4217 Alpha 3 currency code.
bankGiro[0-9-]{5,35}Swedish Bankgiro number
plusGiro[0-9-]{5,35}Swedish Plusgiro number
giroReference
giroNumber[0-9-]{5,35} · requiredSwedish Bankgiro or Plusgiro number
giroTypeSwedish giro type
giroInvoiceReference
Custom invoice reference
sepaInvoiceReference
Custom invoice reference
giroOcrReference
^[0-9]+$Swedish OCR reference.
sepaOcrReference
RF[0-9]{2}[A-Z0-9]+$RF creditor reference.
balanceType
The type of balance represented. See Statuses & Types documentation for full descriptions of values.
accountAccess
Asks for detailed account information. If the array is empty, the TPP asks for an accessible account list, and the arrays for balances and transactions will also be empty.
Asks for balances of the addressed accounts. If the array is empty, the TPP asks for the balances of all accessible accounts, and the arrays for accounts and transactions will also be empty.
Asks for transactions on the addressed accounts. If the array is empty, the TPP asks for the transactions of all accessible accounts and the arrays for accounts and balances will also be empty.
availableAccountsOptional if supported by API provider. Only the values "allAccounts", "allAccountsWithBalances" or "selectAccounts" are allowed.
allPsd2Optional if supported by API provider. Only the value "allAccounts" is allowed.
accountStatus
Account status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
accountDetails
currency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
resourceIdThis shall be filled, if addressable resource are created by the ASPSP on the /accounts or /card-accounts endpoint.
iban[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
bban[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
accountNumber[a-zA-Z0-9]{1,30}Bank account number. Used to identify the particular customer account within the financial institution.
msisdnMobile phone number.
bankgiroNumber[0-9-]{5,35}Swedish Bankgiro number
plusgiroNumber[0-9-]{5,35}Swedish Plusgiro number
nameName of the account given by the bank or the PSU in online-banking.
productProduct name of the bank for this account, proprietary definition.
cashAccountTypeExternalCashAccountType1Code from ISO 20022.
statusAccount status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
bic[A-Z]{6,6}[A-Z2-9][A…BICFI
linkedAccountsCase of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usageSpecifies the usage of the account:
- PRIV: private personal account.
- ORGA: professional account.
detailsSpecifications that might be provided by the ASPSP:
- characteristics of the account.
- characteristics of the relevant card.
Amount of credit extended to account.
A list of balances for the account. This list might be restricted to the current balance.
Links to the account, which can be directly used for retrieving account information from this dedicated account.
Links to "balances" and/or "transactions"
These links are only supported, when the corresponding consent has been already granted.
ownerNameName of the legal account owner. If there is more than one owner, then multiple names might be noted here. For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.
lastTransactionEnrichmentDateTimeThe local date time of the latest ISO transaction enrichment, if enabled.
lastTransactionEnrichmentDateTimeUtcThe UTC date time of the latest ISO transaction enrichment, if enabled.
lastBalanceEnrichmentDateTimeThe local date time of the latest ISO balance enrichment, if enabled.
lastBalanceEnrichmentDateTimeUtcThe UTC date time of the latest ISO balance enrichment, if enabled.
accountDetailsWithTppMessages
currency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
resourceIdThis shall be filled, if addressable resource are created by the ASPSP on the /accounts or /card-accounts endpoint.
iban[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
bban[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
accountNumber[a-zA-Z0-9]{1,30}Bank account number. Used to identify the particular customer account within the financial institution.
msisdnMobile phone number.
bankgiroNumber[0-9-]{5,35}Swedish Bankgiro number
plusgiroNumber[0-9-]{5,35}Swedish Plusgiro number
nameName of the account given by the bank or the PSU in online-banking.
productProduct name of the bank for this account, proprietary definition.
cashAccountTypeExternalCashAccountType1Code from ISO 20022.
statusAccount status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
bic[A-Z]{6,6}[A-Z2-9][A…BICFI
linkedAccountsCase of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usageSpecifies the usage of the account
- PRIV: private personal account
- ORGA: professional account
detailsSpecifications that might be provided by the ASPSP
- characteristics of the account
- characteristics of the relevant card
Amount of credit extended to account.
A list of balances for the account. This list might be restricted to the current balance.
Links to the account, which can be directly used for retrieving account information from this dedicated account.
Links to "balances" and/or "transactions"
These links are only supported, when the corresponding consent has been already granted.
ownerNameName of the legal account owner. If there is more than one owner, then e.g. two names might be noted here.
For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.
lastTransactionEnrichmentDateTimeThe local date time of the latest ISO transaction enrichment, if enabled.
lastTransactionEnrichmentDateTimeUtcThe UTC date time of the latest ISO transaction enrichment, if enabled.
lastBalanceEnrichmentDateTimeThe local date time of the latest ISO balance enrichment, if enabled.
lastBalanceEnrichmentDateTimeUtcThe UTC date time of the latest ISO balance enrichment, if enabled.
cardAccountDetails
maskedPanMasked Primary Account Number.
currency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
resourceIdThis is the data element to be used in the path when retrieving data from a dedicated account. This shall be filled, if addressable resource are created by the ASPSP on the /card-accounts endpoint.
ownerNameName of the legal account owner. If there is more than one owner, then e.g. two names might be noted here.
For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.
nameName of the account, as assigned by the ASPSP, in agreement with the account owner in order to provide an additional means of identification of the account.
displayNameName of the account as defined by the PSU within online channels.
productProduct Name of the Bank for this account, proprietary definition.
debitAccountingIf true, the amounts of debits on the reports are quoted positive with the related consequence for balances. If false, the amount of debits on the reports are quoted negative.
statusAccount status. The value is one of the following:
- "enabled": account is available
- "deleted": account is terminated
- "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
usageSpecifies the usage of the account:
- PRIV: private personal account
- ORGA: professional account
detailsSpecifications that might be provided by the ASPSP:
- characteristics of the account
- characteristics of the relevant card
A list of balances for the account. This list might be restricted to the current balance.
Links to the account, which can be directly used for retrieving account information from this dedicated account.
Links to "balances" and/or "transactions"
These links are only supported, when the corresponding consent has been already granted.
accountList
cardAccountList
accountReport
Array of transaction details
Array of transaction details
Array of transaction details
cardAccountReport
Array of transaction details
Array of transaction details
transactionList
Array of transaction details
transactionIdthe Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request
entryReferenceIs the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.
endToEndIdID for the transaction provided by the initiator, and passed unchanged from debtor to creditor.
mandateIdID of the mandate given by the debtor to the creditor. Relevant for e.g. SEPA Identification of Mandates.
checkIdIdentification of a Cheque.
creditorIdIdentification of Creditors, e.g. a SEPA Creditor ID.
bookingDateThe Date when an entry is posted to an account on the ASPSPs books.
valueDateDate at which an entry is posted to an account on the ASPSP's books.
The account balance at the time after the transaction is made. Only available for transactions in booked state.
Array of exchange rates
creditorName^[A-Za-z0-9 ]{1,70}$Creditor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN), or
- Swedish Bankgiro number, or
- Swedish Plusgiro number.
ultimateCreditorUltimate Creditor
debtorNameDebtor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
ultimateDebtorUltimate Debtor
remittanceInformationUnstructuredUnstructured remittance information
remittanceInformationStructuredReference as contained in the structured remittance reference structure (without the surrounding XML structure).
Different from other places where the content is in plain form and not in form of a structured field.
remittanceInformationUnstructuredArrayArray of unstructured remittance information
Array of structured remittance information
additionalInformationMight be used by the ASPSP to transport additional transaction related information to the PSU.
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
bankTransactionCodeBank transaction code as used by the ASPSP, concatenating the three ISO 20022 Codes (Domain Code, Family Code, SubFamily Code).
proprietaryBankTransactionCodeProprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
transactionListIdGenerated from the transaction details per transaction, meaning that duplicates may occur for identical transactions on the same day with the same account balance at the transaction time. Only available fore transactions in booked state.
paymentIdOnly available for transactions generated via the Open Banking Platform.
Resource identification of the generated payment initiation resource.
aggregateTransactionIdThe transaction ID of the aggregated transaction.
aggregateTransactionListIdThe transaction list ID of the aggregated transaction.
aggregateIdSerial number for the Bankgiro deposit.
aggregateAmountThe aggregated amount of all transactions in the deposit.
aggregateRemittanceInformationUnstructuredThe unstructured remittance information of the aggregated transaction.
debtorOrganisationIdOrganisation number of the debtor.
isAliasPayinIs set if the transaction represents an individual incoming payment derived from an aggregated transaction.
isAliasPayoutIs set if the transaction represents an individual outgoing payment derived from an aggregated transaction.
isEnrichedA transaction that has additional data enriched. Data is sourced from a provider other than PSD2.
Transaction-specific links:
- "transactionDetails": further details about the transaction, only available in some banks.
- "proofOfPayment": link to a downloadable proof of payment document, only available for booked cross-border payments.
Array of transaction fees
cardTransactionList
Array of transaction details
cardTransactionIdUnique end to end identity.
terminalIdIdentification of the Terminal, where the card has been used.
transactionDateDate of the actual card transaction
bookingDateThe Date when an entry is posted to an account on the ASPSPs books.
Array of exchange rates
markupFeePercentagecardAcceptorIdmerchantCategoryCodeMerchant category code
maskedPANMasked Primary Account Number.
transactionDetailsinvoicedproprietaryBankTransactionCodeProprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
transactionDetails
transactionIdthe Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request
entryReferenceIs the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.
endToEndIdID for the transaction provided by the initiator, and passed unchanged from debtor to creditor.
mandateIdID of the mandate given by the debtor to the creditor. Relevant for e.g. SEPA Identification of Mandates.
checkIdIdentification of a Cheque.
creditorIdIdentification of Creditors, e.g. a SEPA Creditor ID.
bookingDateThe Date when an entry is posted to an account on the ASPSPs books.
valueDateDate at which an entry is posted to an account on the ASPSP's books.
The account balance at the time after the transaction is made. Only available for transactions in booked state.
Array of exchange rates
creditorName^[A-Za-z0-9 ]{1,70}$Creditor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN), or
- Swedish Bankgiro number, or
- Swedish Plusgiro number.
ultimateCreditorUltimate Creditor
debtorNameDebtor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
ultimateDebtorUltimate Debtor
remittanceInformationUnstructuredUnstructured remittance information
remittanceInformationStructuredReference as contained in the structured remittance reference structure (without the surrounding XML structure).
Different from other places where the content is in plain form and not in form of a structured field.
remittanceInformationUnstructuredArrayArray of unstructured remittance information
Array of structured remittance information
additionalInformationMight be used by the ASPSP to transport additional transaction related information to the PSU.
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
bankTransactionCodeBank transaction code as used by the ASPSP, concatenating the three ISO 20022 Codes (Domain Code, Family Code, SubFamily Code).
proprietaryBankTransactionCodeProprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
transactionListIdGenerated from the transaction details per transaction, meaning that duplicates may occur for identical transactions on the same day with the same account balance at the transaction time. Only available fore transactions in booked state.
paymentIdOnly available for transactions generated via the Open Banking Platform.
Resource identification of the generated payment initiation resource.
aggregateTransactionIdThe transaction ID of the aggregated transaction.
aggregateTransactionListIdThe transaction list ID of the aggregated transaction.
aggregateIdSerial number for the Bankgiro deposit.
aggregateAmountThe aggregated amount of all transactions in the deposit.
aggregateRemittanceInformationUnstructuredThe unstructured remittance information of the aggregated transaction.
debtorOrganisationIdOrganisation number of the debtor.
isAliasPayinIs set if the transaction represents an individual incoming payment derived from an aggregated transaction.
isAliasPayoutIs set if the transaction represents an individual outgoing payment derived from an aggregated transaction.
isEnrichedA transaction that has additional data enriched. Data is sourced from a provider other than PSD2.
Transaction-specific links:
- "transactionDetails": further details about the transaction, only available in some banks.
- "proofOfPayment": link to a downloadable proof of payment document, only available for booked cross-border payments.
Array of transaction fees
transactionDetailsWithTppMessages
transactionIdthe Transaction Id can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request
entryReferenceIs the identification of the transaction as used e.g. for reference for deltafunction on application level. The same identification as for example used within camt.05x messages.
endToEndIdUnique end to end identity.
mandateIdIdentification of Mandates, e.g. a SEPA Mandate ID.
checkIdIdentification of a Cheque.
creditorIdIdentification of Creditors, e.g. a SEPA Creditor ID.
bookingDateThe Date when an entry is posted to an account on the ASPSPs books.
valueDateDate at which assets become available to the account owner in case of a credit.
Array of exchange rates
creditorName^[A-Za-z0-9 ]{1,70}$Creditor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN), or
- Swedish Bankgiro number, or
- Swedish Plusgiro number.
ultimateCreditorUltimate Creditor
debtorNameDebtor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
ultimateDebtorUltimate Debtor
remittanceInformationUnstructuredUnstructured remittance information
remittanceInformationStructuredReference as contained in the structured remittance reference structure (without the surrounding XML structure).
Different from other places where the content is in plain form and not in form of a structured field.
additionalInformationMight be used by the ASPSP to transport additional transaction related information to the PSU.
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
bankTransactionCodeBank transaction code as used by the ASPSP, concatenating the three ISO 20022 Codes (Domain Code, Family Code, SubFamily Code).
proprietaryBankTransactionCodeProprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
transactionListIdGenerated from the transaction details per transaction, meaning that duplicates may occur for identical transactions on the same day with the same account balance at the transaction time. Only available fore transactions in booked state.
paymentIdOnly available for transactions generated via the Open Banking Platform.
Resource identification of the generated payment initiation resource.
isEnrichedA transaction that has additional data enriched. Data is sourced from a provider other than PSD2.
Transaction-specific links:
- "transactionDetails": further details about the transaction, only available in some banks.
- "proofOfPayment": link to a downloadable proof of payment document, only available for booked cross-border payments.
Array of transaction fees
cardTransaction
cardTransactionIdUnique end to end identity.
terminalIdIdentification of the Terminal, where the card has been used.
transactionDateDate of the actual card transaction
bookingDateThe Date when an entry is posted to an account on the ASPSPs books.
Array of exchange rates
markupFeePercentagecardAcceptorIdmerchantCategoryCodeMerchant category code
maskedPANMasked Primary Account Number.
transactionDetailsinvoicedproprietaryBankTransactionCodeProprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
reportExchangeRateList
Array of exchange rates
sourceCurrency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
exchangeRateunitCurrencytargetCurrency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
quotationDatecontractIdentificationreportExchangeRate
sourceCurrency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
exchangeRateunitCurrencytargetCurrency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
quotationDatecontractIdentificationpaymentExchangeRate
unitCurrencyexchangeRatecontractIdentificationrateTypebalance
balanceTypeThe type of balance represented. See Statuses & Types documentation for full descriptions of values.
creditLimitIncludedA flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
lastChangeDateTimeMight be used to indicate when the balance was last updated.
referenceDateReference date of the balance.
lastCommittedTransaction"entryReference" of the last committed transaction.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
balanceList
A list of balances for the account. This list might be restricted to the current balance.
balanceTypeThe type of balance represented. See Statuses & Types documentation for full descriptions of values.
creditLimitIncludedA flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
lastChangeDateTimeMight be used to indicate when the balance was last updated.
referenceDateReference date of the balance.
lastCommittedTransaction"entryReference" of the last committed transaction.
clearingNumber[0-9]{1,5}Bank account clearing number. Used to identify the financial institution within a domestic payment system.
cancellationList
cancellationIdspan
Primary Account Number according to ISO/IEC 7812.
ownerName
Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here.
For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.
debitAccounting
If true, the amounts of debits on the reports are quoted positive with the related consequence for balances. If false, the amount of debits on the reports are quoted negative.
displayName
Name of the account as defined by the PSU within online channels.
bban
[a-zA-Z0-9]{1,30}Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
iban
[A-Z]{2,2}[0-9]{2,2}…International Bank Account Number (IBAN) of an account.
address
country[A-Z]{2} · requiredISO 3166 ALPHA2 country code
streetbuildingNumbercitypostalCodeinternationalAddress
streetcitypostalCodecountry[A-Z]{2} · requiredISO 3166 ALPHA2 country code
buildingNumberstatecreditorNameAndAddress
Creditor Name and Address in a free text field
amount
currency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
amount-?[0-9]{1,14}(\.[0-9… · requiredThe amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example: Valid representations for EUR with up to two decimals are:
- 1056
- 5768.2
- -1.50
- 5877.78
balanceAfterTransaction
balanceTypeThe type of balance represented. See Statuses & Types documentation for full descriptions of values.
creditLimit
currency[A-Z]{3} · requiredISO 4217 Alpha 3 currency code.
amount-?[0-9]{1,14}(\.[0-9… · requiredThe amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example: Valid representations for EUR with up to two decimals are:
- 1056
- 5768.2
- -1.50
- 5877.78
amountValue
-?[0-9]{1,14}(\.[0-9…The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example: Valid representations for EUR with up to two decimals are:
- 1056
- 5768.2
- -1.50
- 5877.78
chargeBearer
Charge Bearer. ChargeBearerType1Code from ISO20022
remittanceInformationStructured
referencereferenceTypereferenceIssuerremittanceInformationStructuredArray
additionalRemittanceInformationreferredDocumentInformation
typeCodetypeProprietarytypeIssuernumberrelatedDatecreditorReferenceInformation
referencereferenceTypeCodereferenceTypeProprietaryremittanceInformationUnstructured
Unstructured remittance information
remittanceInformationUnstructuredArray
Array of unstructured remittance information
purposeCode
ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
bankTransactionCode
Bank transaction code as used by the ASPSP, concatenating the three ISO 20022 Codes (Domain Code, Family Code, SubFamily Code).
proprietaryBankTransactionCode
Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports.
transactionListId
Generated from the transaction details per transaction, meaning that duplicates may occur for identical transactions on the same day with the same account balance at the transaction time. Only available fore transactions in booked state.
transactionPaymentId
Only available for transactions generated via the Open Banking Platform.
Resource identification of the generated payment initiation resource.
isEnriched
A transaction that has additional data enriched. Data is sourced from a provider other than PSD2.
frequencyCode
The following codes from the "EventFrequency7Code" of ISO 20022 are supported.
- "Daily"
- "Weekly"
- "EveryTwoWeeks"
- "Monthly"
- "EveryTwoMonths"
- "Quarterly"
- "SemiAnnual"
- "Annual"
frequencyPerDay
The number of times per day the TPP may access the account data without PSU interaction. For one-off access, the attribute is set to "1". If not otherwise agreed bilaterally between the TPP and ASPSP, the frequency is less equal to 4.
dayOfExecution
The day of execution as a string. Leading zeroes are not allowed.
executionRule
Specifies how to handle recurring payment dates that fall on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day. The ASPSP might reject the request if the selected option is not supported by its online banking rules.
psuData
passwordPassword
encryptedPasswordEncrypted password.
creditorName
^[A-Za-z0-9 ]{1,70}$Creditor Name
ultimateDebtorName
^[A-Za-z0-9 ]{1,70}$Ultimate Debtor Name
ultimateCreditorName
^[A-Za-z0-9 ]{1,70}$Ultimate Creditor Name
startDate
The first applicable day of execution starting from this date is the first payment.
endDate
The last applicable day of execution If not given, it is an infinite standing order.
validUntil
The date until which the requested consent should be valid for. The content is the local ASPSP date in ISO Date Format, e.g. 2025-10-30. This parameter is requesting a valid until date for the requested consent.
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.
isoPaymentInitiation_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
debtorAccountMessageMessage for the debtor
List of credit notes to be offset against the payment.
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
paymentInitiation_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
debtorAccountMessageMessage for the debtor
endToEndIdentificationpaymentInitiationCrossBorder_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
debtorAccountMessageMessage for the debtor
endToEndIdentificationpurposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
Additional regulatory reporting information, if applicable.
isoPaymentInitiationCrossBorder_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
debtorAccountMessageMessage for the debtor
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
List of credit notes to be offset against the payment.
Additional regulatory reporting information, if applicable.
paymentInitiationSepaDirectDebit_json
requestedExecutionDateDate when payment is scheduled to be collected in ISO-Date Format, e.g. 2020-10-30.
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorId^[A-Z]{2}\d{2}[A-Z0-… · requiredA unique identifier assigned to the creditor authorising them to initiate SEPA Direct Debit collections.
localInstrumentCodeLocal instrument code. See Statuses & Types documentation for full descriptions of values.
sequenceTypeSequence type for SEPA Direct Debit collections. See Statuses & Types documentation for full descriptions of values.
Mandate information that authorises the SEPA Direct Debit.
debtorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
debtorNameDebtor Name
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
instructionIdInstruction Id – identification for end-to-end processing.
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
chargeBearerCharge Bearer. ChargeBearerType1Code from ISO20022
ultimateCreditorName^[A-Za-z0-9 ]{1,70}$Ultimate Creditor Name
debtorAgentNameDebtor Agent Name
ultimateDebtorName^[A-Za-z0-9 ]{1,70}$Ultimate Debtor Name
purposeCodeExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
remittanceInformationUnstructuredArrayArray of unstructured remittance information
Array of structured remittance information elements.
Up to 10 regulatory reporting items.
directDebitSequenceType
Sequence type for SEPA Direct Debit collections. See Statuses & Types documentation for full descriptions of values.
directDebitMandateRelatedInformation
mandateIdMandate Id.
dateOfSignatureDate of signature.
party
namedirectDebitReferenceTypeCode
Reference type for structured remittance.
directDebitStructuredRemittanceInformation
referencereferenceTypeReference type for structured remittance.
directDebitStructuredRemittanceInformationArray
Array of structured remittance information elements.
referencereferenceTypeReference type for structured remittance.
directDebitRegulatoryReportingData
detailsCodedetailsInformationdirectDebitRegulatoryReportingArray
Up to 10 regulatory reporting items.
detailsCodedetailsInformationpaymentInitiationSct_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
invoiceRefCustom invoice reference
ocrRefRF[0-9]{2}[A-Z0-9]+$RF creditor reference.
debtorAccountMessageMessage for the debtor
endToEndIdentificationregulatoryReporting
Additional regulatory reporting information, if applicable.
detailsCodedetailsInformationisoPaymentInitiationSct_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A… · requiredBICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
remittanceInformationUnstructuredUnstructured remittance information
debtorAccountMessageMessage for the debtor
List of credit notes to be offset against the payment.
paymentInitiationSwedishGiro_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to a Swedish Bankgiro or Plusgiro account
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
invoiceRefCustom invoice reference
ocrRef^[0-9]+$Swedish OCR reference.
debtorAccountMessagecreditorAccountMessageendToEndIdentificationisoPaymentInitiationSwedishGiro_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or,
- Bankgiro/Plusgiro for corporate Swedish accounts, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to a Swedish Bankgiro or Plusgiro account
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
creditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
creditorAgentNameCreditor Agent Name
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
invoiceRefCustom invoice reference
ocrRef^[0-9]+$Swedish OCR reference.
debtorAccountMessagecreditorAccountMessageList of credit notes to be offset against the payment.
creditNotes
List of credit notes to be offset against the payment.
referenceCustom invoice reference
confirmationOfFunds
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
cardNumberCard Number of the card issued by the PIISP. Should be delivered if available.
payeeName payee
fxQuote
sourceCurrencyThe source currency.
targetCurrencyThe target currency.
countryCodeThe target country.
amountThe requested amount in target currency.
requestedExecutionDateThe requested execution date, for future payments.
consents
Requested access services for a consent.
recurringIndicatorIf "true", the consent is for recurring access to the account data. If "false", the consent is for one-off access to the account data.
validUntilThe date until which the requested consent should be valid for. The content is the local ASPSP date in ISO Date Format, e.g. 2025-10-30. This parameter is requesting a valid until date for the requested consent.
frequencyPerDayThe number of times per day the TPP may access the account data without PSU interaction. For one-off access, the attribute is set to "1". If not otherwise agreed bilaterally between the TPP and ASPSP, the frequency is less equal to 4.
combinedServiceIndicatorIf "true" indicates that a payment initiation service will be addressed in the same "session".
updatePsuAuthentication
PSU Data for Update PSU Authentication.
selectPsuAuthenticationMethod
authenticationMethodIdAn identification provided by the ASPSP for the later identification of the authentication method selection.
transactionAuthorisation
scaAuthenticationDataSCA authentication data, depending on the chosen authentication method. If the data is binary, then it is base64 encoded.
paymentInitiationSct_pain.001
A pain.001 structure corresponding to the SCT schema
urn:iso:std:iso:20022:tech:xsd:pain.001.001.03
paymentInitiationTarget2_pain.001
A pain.001 structure corresponding to the target-2 schema
For TARGET-2 payments only community wide pain.001 schemes do exist.
paymentInitiationCrossBorder_pain.001
A pain.001 structure corresponding to the cross-border schema
For cross-border payments only community wide pain.001 schemes do exist.
paymentInitiationStatusResponse-200_json
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
paymentInitiationStatusResponse-200_xml
Body of the response for a successful payment initiation status request in case of an XML based endpoint.
The status is returned as a pain.002 structure.
urn:iso:std:iso:20022:tech:xsd:pain.002.001.03
The chosen XML schema of the Status Request is following the XML schema definitions of the original pain.001 schema.
isoPaymentInitiationRequestResponse-201
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
paymentIdID of the generated payment initiation resource. Only available for transactions generated via the Open Banking Platform.
_linksA list of hyperlinks to be recognised by the TPP. Type of links admitted in this response:
-
'confirmPayment': The link to the confirm endpoint, where a payment file is generated from the confirmed payment instructions.
-
'self': The link to the payment initiation resource created by this request.
paymentInitiationRequestResponse-201
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
paymentIdID of the generated payment initiation resource. Only available for transactions generated via the Open Banking Platform.
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.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- '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).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation endpoint, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication':
The link to the authorisation endpoint, where the authorisation sub-resource has to be generated while
uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisationWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation endpoint, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element "scaMethods"
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation endpoint, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
psuMessageText to be displayed to the PSU
Body of the JSON response for a successful VoP request.
paymentInitiationCancelResponse-202
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
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.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'startAuthorisation': In case, where just the authorisation process of the cancellation needs to be started, but no additional data needs to be updated for time being (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded).
- 'startAuthorisationWithPsuIdentification': In case where a PSU Identification needs to be updated when starting the cancellation authorisation: The link to the cancellation-authorisations end-point, where the cancellation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': In case of a yet to be created authorisation sub-resource: The link to the cancellation authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisationWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the cancellation-authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
paymentInitiationWithStatusResponse
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
endToEndIdentificationcreditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
remittanceInformationUnstructuredUnstructured remittance information
Structured remittance information
debtorAccountMessageMessage for the debtor
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
paymentInitiationSwedishGiroWithStatusResponse
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
endToEndIdentificationcreditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
remittanceInformationUnstructuredUnstructured remittance information
Structured remittance information
requestedExecutionDateDate when payment is scheduled to be executed in ISO-Date Format, e.g. 2020-10-30
debtorAccountMessagecreditorAccountMessagetransactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
periodicPaymentInitiationWithStatusResponse
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorName^[A-Za-z0-9 ]{1,70}$ · requiredCreditor Name
startDateThe first applicable day of execution starting from this date is the first payment.
frequencyThe following codes from the "EventFrequency7Code" of ISO 20022 are supported.
- "Daily"
- "Weekly"
- "EveryTwoWeeks"
- "Monthly"
- "EveryTwoMonths"
- "Quarterly"
- "SemiAnnual"
- "Annual"
endToEndIdentificationcreditorAgent[A-Z]{6,6}[A-Z2-9][A…BICFI
remittanceInformationUnstructuredUnstructured remittance information
endDateThe last applicable day of execution If not given, it is an infinite standing order.
executionRuleSpecifies how to handle recurring payment dates that fall on a weekend or bank holiday. The payment is then executed on either the "preceding" or "following" working day. The ASPSP might reject the request if the selected option is not supported by its online banking rules.
dayOfExecutionThe day of execution as a string. Leading zeroes are not allowed.
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
scaStatusResponse
scaStatusContains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
startScaprocessResponse
scaStatusContains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
authorisationIdResource identification of the related SCA
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.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- 'updatePsuIdentification': The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.
- 'startAuthorisationWithPsuAuthentication':
The link to the authorisation or cancellation authorisation sub-resource,
where PSU authentication data needs to be uploaded.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisationWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'selectAuthenticationMethod': The link to the authorisation or cancellation authorisation sub-resource, where the selected authentication method needs to be uploaded. This link is contained under exactly the same conditions as the data element 'scaMethods'.
- 'authoriseTransaction': The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
psuMessageText to be displayed to the PSU
updatePsuIdenticationResponse
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.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
scaStatusContains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
psuMessageText to be displayed to the PSU
updatePsuAuthenticationResponse
scaStatusContains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
A list of hyperlinks to be recognised by the TPP. Might be contained, if several authentication methods are available for the PSU. Type of links admitted in this response:
- 'selectAuthenticationMethod': This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. This link is only contained, if the PSU is already identified or authenticated with the first relevant factor or alternatively an access token, if SCA is required and if the PSU has a choice between different authentication methods. If this link is contained, then there is also the data element 'scaMethods' contained in the response body.
- 'authoriseTransaction': The link to the resource, where the "Transaction Authorisation Request" is sent to. This is the link to the resource which will authorise the transaction by checking the SCA authentication data within the Embedded SCA approach.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
psuMessageText to be displayed to the PSU
selectPsuAuthenticationMethodResponse
scaStatusContains information about the status of the SCA method applied. See Statuses & Types documentation for full descriptions of values.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
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.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Remark: This method can be applied before or after PSU identification. This leads to many possible hyperlink responses. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- "scaRedirect": In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- "scaOAuth": In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- "updatePsuIdentification": The link to the authorisation or cancellation authorisation sub-resource, where PSU identification data needs to be uploaded.
- "updatePsuAuthentication": The link to the authorisation or cancellation authorisation sub-resource, where PSU authentication data needs to be uploaded. "authoriseTransaction": The link to the authorisation or cancellation authorisation sub-resource, where the authorisation data has to be uploaded, e.g. the TOP received by SMS. "scaStatus": The link to retrieve the scaStatus of the corresponding authorisation sub-resource.
psuMessageText to be displayed to the PSU
signingBasketResponse-200
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
paymentIdsA list of paymentIds.
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.
Remark: All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- '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).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the encrypted PSU authentication data.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
signingBasketStatusResponse-200
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
signingBasketResponse-201
transactionStatusUses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values.
basketIdID of the generated signing basket resource.
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.
Remark: All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- '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).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the encrypted PSU authentication data.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the transaction status of the payment initiation.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
psuMessageText to be displayed to the PSU
consentsResponse-201
consentStatusOverall lifecycle status of the consent. See Statuses & Types documentation for full descriptions of values.
consentIdID of the corresponding consent object as returned by an Account Information Consent Request.
A list of hyperlinks to be recognised by the TPP.
Type of links admitted in this response (which might be extended by single ASPSPs as indicated in its XS2A documentation):
- 'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
- 'scaOAuth': In case of an OAuth2 based Redirect Approach, the ASPSP is transmitting the link where the configuration of the OAuth2 Server is defined. The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
- '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).
- 'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
- 'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisationWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
- 'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element 'scaMethods'
- 'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
- 'self': The link to the Establish Account Information Consent resource created by this request. This link can be used to retrieve the resource data.
- 'status': The link to retrieve the status of the account information consent.
- 'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
Optional list of available Strong Customer Authentication (SCA) methods, shown if SCA is required and the user can choose a method. When this is present, a startAuthorisationWithAuthenticationMethodSelection link will also be included for starting the authorisation with method selection.
Authentication Object
Contained in addition to the data element chosenScaMethod if challenge data is needed for SCA. In rare cases, this attribute is also used in the context of the startAuthorisationWithPsuAuthentication link.
messageText to be displayed to the PSU, e.g. in a Decoupled SCA Approach.
consentStatusResponse-200
consentStatusOverall lifecycle status of the consent. See Statuses & Types documentation for full descriptions of values.
consentInformationResponse-200_json
Requested access services for a consent.
recurringIndicatorIf "true", the consent is for recurring access to the account data. If "false", the consent is for one-off access to the account data.
validUntilThe date until which the requested consent should be valid for. The content is the local ASPSP date in ISO Date Format, e.g. 2025-10-30. This parameter is requesting a valid until date for the requested consent.
frequencyPerDayThe number of times per day the TPP may access the account data without PSU interaction. For one-off access, the attribute is set to "1". If not otherwise agreed bilaterally between the TPP and ASPSP, the frequency is less equal to 4.
lastActionDateThis 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.
consentStatusOverall lifecycle status of the consent. See Statuses & Types documentation for full descriptions of values.
A list of hyperlinks to be recognised by the TPP.
Links of type "account" and/or "cardAccount", depending on the nature of the consent.
fxQuoteResponse-200
fxQuoteIdResource identification of the generated FX quote.
fxRateRate of the generated FX quote.
feeFee of the generated FX quote.
validFromThe FX quote is valid from this date.
validToThe FX quote is valid to this date.
fxQuoteResponse-201
fxQuoteIdResource identification of the generated FX quote.
fxRateRate of the generated FX quote.
feeFee of the generated FX quote.
totalAmountTotal amount of the generated FX quote.
validFromThe FX quote is valid from this date.
validToThe FX quote is valid to this date.
readAccountBalanceResponse-200
A list of balances for the account. This list might be restricted to the current balance.
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
readCardAccountBalanceResponse-200
A list of balances for the account. This list might be restricted to the current balance.
Card account details.
transactionsResponse-200_json
Reference to an account by either
- IBAN, of a payment account, or
- BBAN, for payment accounts if there is no IBAN, or
- the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
- the Primary Account Number (PAN) of a card in a masked form, or
- an alias to access a payment account via a registered mobile phone number (MSISDN).
JSON based account report. This account report contains transactions resulting from the query parameters.
'booked' shall be contained if bookingStatus parameter is set to "booked" or "both".
'pending' is not contained if the bookingStatus parameter is set to "booked".
A list of balances for the account. This list might be restricted to the current balance.
A list of hyperlinks to be recognised by the TPP.
Type of links admitted in this response:
- "download": a link to a resource, where the transaction report might be downloaded from in case where transaction reports have a huge size.
Remark: This feature shall only be used where camt-data is requested which has a huge size.
cardAccountsTransactionsResponse200
Card account details.
JSON based card account report.
This card account report contains transactions resulting from the query parameters.
A list of balances for the account. This list might be restricted to the current balance.
A list of hyperlinks to be recognised by the TPP.
Type of links admitted in this response:
- "download": a link to a resource, where the transaction report might be downloaded from in case where transaction reports have a huge size.
Remark: This feature shall only be used where camt-data is requested which has a huge size.
_linksAll
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
_linksPaymentInitiation
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
_linksPaymentInitiationCancel
_linksUpdatePsuIdentification
Link to a resource
_linksUpdatePsuAuthentication
_linksSelectPsuAuthenticationMethod
_linksStartScaProcess
_linksDownload
Link to a resource
_linksConsents
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
_linksSigningBasket
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
Link to a resource
_linksAccountDetails
tppMessageCategory
Category of the TPP message category
MessageCode_GetCreditorName2XX
Message codes for HTTP Error codes 2XX.
MessageCode400_AIS
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
MessageCode400_PIS
Message codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
MessageCode400_PIIS
Message codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
MessageCode400_SBS
Message codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).
MessageCode401_PIS
Message codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
MessageCode401_AIS
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
MessageCode401_PIIS
Message codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
MessageCode401_SBS
Message codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).
MessageCode403_PIS
Message codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
MessageCode403_AIS
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
MessageCode403_PIIS
Message codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
MessageCode403_SBS
Message codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).
MessageCode404_PIS
Message codes defined for PIS for HTTP Error code 404 (NOT FOUND).
MessageCode404_AIS
Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).
MessageCode404_PIIS
Message codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
MessageCode404_SBS
Message codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).
MessageCode405_PIS
Message codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
MessageCode405_PIS_CANC
Message codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
MessageCode405_AIS
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
MessageCode405_PIIS
Message codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
MessageCode405_SBS
Message codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).
MessageCode406_AIS
Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
MessageCode409_AIS
Message codes defined for AIS for HTTP Error code 409 (CONFLICT).
MessageCode409_PIS
Message codes defined for PIS for HTTP Error code 409 (CONFLICT).
MessageCode409_PIIS
Message codes defined for PIIS for HTTP Error code 409 (CONFLICT).
MessageCode409_SBS
Message codes defined for signing baskets for HTTP Error code 409 (CONFLICT).
MessageCode429_AIS
Message codes for HTTP Error code 429 (TOO MANY REQUESTS).
MessageCode502_PIS
Message code for HTTP Error code 502 (BAD GATEWAY).
tppMessage2XX
categoryCategory of the TPP message category
codeMessage codes for HTTP Error codes 2XX.
pathtextAdditional explaining text to the TPP.
tppMessage2XX_GetCreditorName
categoryCategory of the TPP message category
codeMessage codes for HTTP Error codes 2XX.
pathtextAdditional explaining text to the TPP.
tppMessage400_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
pathtextAdditional explaining text to the TPP.
tppMessage400_PIS
categoryCategory of the TPP message category
codeMessage codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
pathtextAdditional explaining text to the TPP.
tppMessage400_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
pathtextAdditional explaining text to the TPP.
tppMessage400_SBS
categoryCategory of the TPP message category
codeMessage codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).
pathtextAdditional explaining text to the TPP.
tppMessage401_PIS
categoryCategory of the TPP message category
codeMessage codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
pathtextAdditional explaining text to the TPP.
tppMessage401_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
pathtextAdditional explaining text to the TPP.
tppMessage401_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 401 (UNAUTHORIZED).
pathtextAdditional explaining text to the TPP.
tppMessage401_SBS
categoryCategory of the TPP message category
codeMessage codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).
pathtextAdditional explaining text to the TPP.
tppMessage403_PIS
categoryCategory of the TPP message category
codeMessage codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
pathtextAdditional explaining text to the TPP.
tppMessage403_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
pathtextAdditional explaining text to the TPP.
tppMessage403_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
pathtextAdditional explaining text to the TPP.
tppMessage403_SBS
categoryCategory of the TPP message category
codeMessage codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).
pathtextAdditional explaining text to the TPP.
tppMessage404_PIS
categoryCategory of the TPP message category
codeMessage codes defined for PIS for HTTP Error code 404 (NOT FOUND).
pathtextAdditional explaining text to the TPP.
tppMessage404_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 404 (NOT FOUND).
pathtextAdditional explaining text to the TPP.
tppMessage404_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
pathtextAdditional explaining text to the TPP.
tppMessage404_SBS
categoryCategory of the TPP message category
codeMessage codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).
pathtextAdditional explaining text to the TPP.
tppMessage405_PIS
categoryCategory of the TPP message category
codeMessage codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
pathtextAdditional explaining text to the TPP.
tppMessage405_PIS_CANC
categoryCategory of the TPP message category
codeMessage codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
pathtextAdditional explaining text to the TPP.
tppMessage405_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
pathtextAdditional explaining text to the TPP.
tppMessage405_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
pathtextAdditional explaining text to the TPP.
tppMessage405_SBS
categoryCategory of the TPP message category
codeMessage codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).
pathtextAdditional explaining text to the TPP.
tppMessage409_PIS
categoryCategory of the TPP message category
codeMessage codes defined for PIS for HTTP Error code 409 (CONFLICT).
pathtextAdditional explaining text to the TPP.
tppMessage406_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
pathtextAdditional explaining text to the TPP.
tppMessage409_AIS
categoryCategory of the TPP message category
codeMessage codes defined for AIS for HTTP Error code 409 (CONFLICT).
pathtextAdditional explaining text to the TPP.
tppMessage409_PIIS
categoryCategory of the TPP message category
codeMessage codes defined for PIIS for HTTP Error code 409 (CONFLICT).
pathtextAdditional explaining text to the TPP.
tppMessage409_SBS
categoryCategory of the TPP message category
codeMessage codes defined for signing baskets for HTTP Error code 409 (CONFLICT).
pathtextAdditional explaining text to the TPP.
tppMessage429_AIS
categoryCategory of the TPP message category
codeMessage codes for HTTP Error code 429 (TOO MANY REQUESTS).
pathtextAdditional explaining text to the TPP.
tppMessage502_PIS
categoryCategory of the TPP message category
codeMessage code for HTTP Error code 502 (BAD GATEWAY).
textAdditional explaining text to the TPP.
tppMessage_GENERIC-FORMAT_ERROR_400
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-PARAMETER_NOT_SUPPORTED_400
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-RESOURCE_UNKNOWN_404_403_400
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-RESOURCE_EXPIRED_403_400
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-TOKEN_UNKNOWN_401
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-TOKEN_INVALID_401
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-TOKEN_EXPIRED_401
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-SERVICE_BLOCKED_403
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-SERVICE_INVALID_400_405
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage-REQUESTED_FORMATS_INVALID_406
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage_GENERIC-CONFLICT_409
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppMessage-ACCESS_EXCEEDED_429
categoryCategory of the TPP message category
codepathtextAdditional explaining text to the TPP.
tppErrorTitle
Short human readable description of error type. Could be in local language. To be provided by ASPSPs.
tppErrorDetail
Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Error400_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIS for HTTP Error code 400 (BAD_REQUEST).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error400_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error400_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIIS for HTTP Error code 400 (BAD_REQUEST).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error400_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for signing baskets for HTTP Error code 400 (BAD_REQUEST).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error401_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error401_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error401_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIS for HTTP Error code 401 (UNAUTHORIZED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error401_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for signing baskets for HTTP Error code 401 (UNAUTHORIZED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error403_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined defined for PIS for PIS for HTTP Error code 403 (FORBIDDEN).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error403_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 403 (FORBIDDEN).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error403_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIIS for HTTP Error code 403 (FORBIDDEN).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error403_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for signing baskets for HTTP Error code 403 (FORBIDDEN).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error404_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIS for HTTP Error code 404 (NOT FOUND).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error404_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 404 (NOT FOUND).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error404_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIIS for HTTP Error code 404 (NOT FOUND).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error404_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for signing baskets for HTTP Error code 404 (NOT FOUND).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error405_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error405_PIS_CANC
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for payment cancellations PIS for HTTP Error code 405 (METHOD NOT ALLOWED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error405_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error405_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIIS for HTTP Error code 405 (METHOD NOT ALLOWED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error405_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for SBS for HTTP Error code 405 (METHOD NOT ALLOWED).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error406_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error409_PIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIS for HTTP Error code 409 (CONFLICT).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error409_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for AIS for HTTP Error code 409 (CONFLICT).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error409_PIIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for PIIS for HTTP Error code 409 (CONFLICT).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error409_SBS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes defined for signing baskets for HTTP Error code 409 (CONFLICT).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error429_AIS
typeA URI reference [RFC3986] that identifies the problem type. Remark For Future: These URI will be provided by NextGenPSD2 in future.
codeMessage codes for HTTP Error code 429 (TOO MANY REQUESTS).
titleShort human readable description of error type. Could be in local language. To be provided by ASPSPs.
detailDetailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition. Remark for Future: In future, a dedicated field might be introduced for the XPath.
Array of Error Information Blocks.
Might be used if more than one error is to be communicated
A _link object with all available link types
Error400_NG_PIS
A _link object with all available link types
Error400_NG_AIS
A _link object with all available link types
Error400_NG_PIIS
A _link object with all available link types
Error400_NG_SBS
A _link object with all available link types
Error401_NG_PIS
A _link object with all available link types
Error401_NG_AIS
A _link object with all available link types
Error401_NG_PIIS
A _link object with all available link types
Error401_NG_SBS
A _link object with all available link types
Error403_NG_PIS
A _link object with all available link types
psuMessageError403_NG_AIS
A _link object with all available link types
Error403_NG_PIIS
A _link object with all available link types
Error403_NG_SBS
A _link object with all available link types
Error404_NG_PIS
A _link object with all available link types
Error404_NG_AIS
A _link object with all available link types
Error404_NG_PIIS
A _link object with all available link types
Error404_NG_SBS
A _link object with all available link types
Error405_NG_PIS
A _link object with all available link types
Error405_NG_PIS_CANC
A _link object with all available link types
Error405_NG_AIS
A _link object with all available link types
Error405_NG_PIIS
A _link object with all available link types
Error405_NG_SBS
A _link object with all available link types
Error406_NG_AIS
A _link object with all available link types
Error409_NG_PIS
A _link object with all available link types
Error409_NG_AIS
A _link object with all available link types
Error409_NG_PIIS
A _link object with all available link types
Error409_NG_SBS
A _link object with all available link types
Error429_NG_AIS
A _link object with all available link types
Error502_NG_PIS
aspsp
bicFi^[A-Z]{6,6}[A-Z2-9][…namelogoUrlcitycountrypostalCodestreetAddresscompanyNumberphonewebsiteUrlglobalPaymentProductsPayment products supported by the ASPSP.
Authorization methods supported by the ASPSP.
Affiliates of the ASPSP.
Capabilities and constraints related to account information access.
Capabilities and constraints related to payment initiation.
accountInformationCapabilities
transactionHistoryMaxDaysMaximum number of days of standard transaction history available if limited by the ASPSP.
extendedTransactionHistoryMaxDaysMaximum days of extended transaction history available after consent authorisation if supported by the ASPSP.
extendedTransactionHistoryAvailableWindowMinutesTime window in minutes during which extended transaction history remains available after consent authorisation.
transactionHistoryMaxCountMaximum number of historical transactions available if limited by the ASPSP.
paymentInitiationCapabilities
signingBasketsSupportedIndicates whether signing baskets are supported by the ASPSP.
signingBasketLimitMaximum number of paymentIds allowed in a signing basket if supported by the ASPSP.
supportedAuthorizationMethods
Authorization methods supported by the ASPSP.
nameName of the authorization method.
uriURI of the authorization method.
supportedAuthorizationMethodItem
nameName of the authorization method.
uriURI of the authorization method.
affiliatedAspsps
Affiliates of the ASPSP.
idID of the affiliated ASPSP.
nameName of the affiliated ASPSP.
affiliatedAspspItem
idID of the affiliated ASPSP.
nameName of the affiliated ASPSP.
aspspListItem
bicFi^[A-Z]{6,6}[A-Z2-9][…namelogoUrlcityList
city
cityIdnameisoCountryCode