openFinance API Framework Extended Account Information Services (2.2)
The core XS2A Interface as introduced above is already supporting Account Information Services (AIS) for current accounts and card reconciliation accounts. These services follow the functionality of online channels of the related ASPSP: Via the services, information on accounts, balances and transactions can be requested for the supported account types. Each request must refer to an underlying consent from the PSU that grants the TPP access to the requested information. For the envisaged Extended Services, the account information function of the openFinance API will go beyond account types defined by the core XS2A Interface. As new entities as a basis of information, the following are supported: * single cards (in contrast to card reconciliation accounts) * savings accounts * loan accounts * securities accounts. Note: Even if introduced for TPP related scenarios, the related premium payment services and related technical endpoints could also be offered in a direct access scenario e.g. for corporates of an ASPSP to request information on their corresponding accounts / cards directly.
List accounts
/v2/securities-accounts
Reads a list of securities accounts. See "Implementation Guidelines for Extended Services ", section "4.5.1 Read Account List".
Query parameters
| Parameter | Type | Description |
|---|---|---|
| evaluationCurrency | string , optional |
ISO Alpha-3 currency code to request evaluation of the balances in a specific currency. This query parameter might be ignored by the ASPSP, if evaluation is not supported for variable currencies or does not support evaluation in the requested currency. Example: Pattern: [A-Z]{3} |
Header parameters
| Header | Type | Description |
|---|---|---|
| Digest | string , optional |
Integrity hash of the request body in the form Example: |
| x-jws-signature | string , optional |
Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed. |
| X-Request-ID | string , required |
Unique ID of the request, set by the initiating party and echoed back in the response. Example: Format: uuid |
| API-Contract-ID | string , optional |
Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service. Example: Format: uuid |
| PSU-IP-Address | string , optional |
IP address of the PSU's device as forwarded by the TPP. If unavailable, use the IP address the TPP used for this request. Example: Format: ipv4 |
| Consent-ID | string , optional |
Identifier of the consent that authorises this access, as returned when the consent was created. Example: Allowed length: max: 70 |
Responses
Select a status code to see the structure and an example of the response.
| Field | Type | Description |
|---|---|---|
| accounts | array[object] , required |
In case, no account is accessible, the ASPSP shall return an empty array.As this is also considered a positive response, the Response code must still be 200. |
| bic | string , optional |
The BIC associated to the account. |
| bban | string , optional |
BBAN of the account. This data elements is used for payment accounts which have no IBAN. |
| iban | string , optional |
IBAN of the account. |
| name | string , optional |
Name 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. |
| other | object , optional |
An alias with a proprietary coding |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of an account. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: AIIN, BBAN, CUID, UPIC |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| owner | object , optional |
The party that legally owns the account. |
| name | string , required |
Account owner name |
| role | string , optional |
The following proprietary codes are used: "owner", "legalRepresentative", "authorisedUser". |
| postalAddress | object , optional |
Information that locates and identifies a specific address, as defined by postal services. |
| room | string , optional |
Building room number. |
| floor | string , optional |
Floor or storey within a building. |
| country | string , optional |
Nation with its own government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| postBox | string , optional |
Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. |
| postCode | string , optional |
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. |
| townName | string , optional |
Name of a built-up area, with defined boundaries, and a local government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| department | string , optional |
Identification of a division of a large organisation or building. |
| streetName | string , optional |
Name of a street or thoroughfare. |
| addressLines | array[string] , optional |
At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. *Remark:* For SEPA transactions this is further restricted to a maximum of 1 entry. |
| buildingName | string , optional |
Name of the building or house. |
| districtName | string , optional |
Identifies a subdivision within a country sub-division. |
| subDepartment | string , optional |
Identification of a sub-division of a large organisation or building. |
| buildingNumber | string , optional |
Number that identifies the position of a building on a street. |
| townLocationName | string , optional |
Specific location name within the town. |
| countrySubDivision | string , optional |
Identifies a subdivision of a country such as state, region, county. |
| contactDetails | object , optional |
Set of elements used to indicated how to contact the party. |
| name | string , optional |
|
| jobTitle | string , optional |
Title of the function. |
| faxNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| department | string , optional |
Identification of a division of a large organisation or building. |
| namePrefix | string , optional |
Specifies the terms used to formally address a person. Allowed values: DOCT, MADM, MISS, MIST, MIKS |
| phoneNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| emailAddress | string , optional |
Address for electronic mail (e-mail). |
| emailPurpose | string , optional |
Purpose for which an email address may be used. |
| mobileNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| responsibility | string , optional |
Role of a person in an organisation. |
| preferredMethod | string , optional |
Preferred method used to reach the contact. Allowed values: LETT, MAIL, PHON, FAXX, CELL |
| identification | object , optional |
Unique and unambiguous identification of a party |
| privateId | object , optional |
A scheme name defined in a proprietary way. |
| others | array[object] , optional |
Unique identification of a person, as assigned by an institution, using an identification scheme. Shall be used if none of the above attributes is used. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of a oersib. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: ARNU, CCPT, CUST, DRLC, EMPL, NIDN, SOSE, TELE, TXID, POID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| birthDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| cityOfBirth | string , optional |
|
| countryOfBirth | string , optional |
ISO 3166-1 alpha-2 country code. |
| provinceOfBirth | string , optional |
|
| organisationId | object , optional |
An entry provided by an external ISO code list |
| lei | string , optional |
Legal Entity Identifier. |
| anyBIC | string , optional |
A code allocated to a business entity or to a financial institution by a Registration Authority under an international identification scheme. |
| others | array[object] , optional |
Unique identification of an organisation, as assigned by an institution, using an identification scheme. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of an organisation. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: BANK, CBID, CHID, CINC, COID, CUST, DUNS, EMPL, GS1G, SREN, SRET, TXID, BDID, BOID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| countryOfResidence | string , optional |
Country in which a person resides. In case of a company, it is the country from which the affairs of that company are directed. Constraints: The code is checked against the list of country names obtained from the United Nations (ISO 3166 Alpha-2 code). |
| usage | string , optional |
Specifies the usage of the account * "PRIV": private personal account * "ORGA": professional account |
| msisdn | string , optional |
An alias to access a payment account via a registered mobile phone number. This alias might be needed e.g. in the payment initiation services. The support of this alias must be explicitly documented by the ASPSP for the corresponding API Calls. |
| owners | array[object] , optional |
List of account owners. |
| name | string , required |
Account owner name |
| role | string , optional |
The following proprietary codes are used: "owner", "legalRepresentative", "authorisedUser". |
| postalAddress | object , optional |
Information that locates and identifies a specific address, as defined by postal services. |
| room | string , optional |
Building room number. |
| floor | string , optional |
Floor or storey within a building. |
| country | string , optional |
Nation with its own government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| postBox | string , optional |
Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. |
| postCode | string , optional |
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. |
| townName | string , optional |
Name of a built-up area, with defined boundaries, and a local government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| department | string , optional |
Identification of a division of a large organisation or building. |
| streetName | string , optional |
Name of a street or thoroughfare. |
| addressLines | array[string] , optional |
At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. *Remark:* For SEPA transactions this is further restricted to a maximum of 1 entry. |
| buildingName | string , optional |
Name of the building or house. |
| districtName | string , optional |
Identifies a subdivision within a country sub-division. |
| subDepartment | string , optional |
Identification of a sub-division of a large organisation or building. |
| buildingNumber | string , optional |
Number that identifies the position of a building on a street. |
| townLocationName | string , optional |
Specific location name within the town. |
| countrySubDivision | string , optional |
Identifies a subdivision of a country such as state, region, county. |
| contactDetails | object , optional |
Set of elements used to indicated how to contact the party. |
| name | string , optional |
|
| jobTitle | string , optional |
Title of the function. |
| faxNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| department | string , optional |
Identification of a division of a large organisation or building. |
| namePrefix | string , optional |
Specifies the terms used to formally address a person. Allowed values: DOCT, MADM, MISS, MIST, MIKS |
| phoneNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| emailAddress | string , optional |
Address for electronic mail (e-mail). |
| emailPurpose | string , optional |
Purpose for which an email address may be used. |
| mobileNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| responsibility | string , optional |
Role of a person in an organisation. |
| preferredMethod | string , optional |
Preferred method used to reach the contact. Allowed values: LETT, MAIL, PHON, FAXX, CELL |
| identification | object , optional |
Unique and unambiguous identification of a party |
| privateId | object , optional |
A scheme name defined in a proprietary way. |
| others | array[object] , optional |
Unique identification of a person, as assigned by an institution, using an identification scheme. Shall be used if none of the above attributes is used. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of a oersib. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: ARNU, CCPT, CUST, DRLC, EMPL, NIDN, SOSE, TELE, TXID, POID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| birthDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| cityOfBirth | string , optional |
|
| countryOfBirth | string , optional |
ISO 3166-1 alpha-2 country code. |
| provinceOfBirth | string , optional |
|
| organisationId | object , optional |
An entry provided by an external ISO code list |
| lei | string , optional |
Legal Entity Identifier. |
| anyBIC | string , optional |
A code allocated to a business entity or to a financial institution by a Registration Authority under an international identification scheme. |
| others | array[object] , optional |
Unique identification of an organisation, as assigned by an institution, using an identification scheme. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of an organisation. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: BANK, CBID, CHID, CINC, COID, CUST, DUNS, EMPL, GS1G, SREN, SRET, TXID, BDID, BOID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| countryOfResidence | string , optional |
Country in which a person resides. In case of a company, it is the country from which the affairs of that company are directed. Constraints: The code is checked against the list of country names obtained from the United Nations (ISO 3166 Alpha-2 code). |
| status | string , optional |
Account status. If this field is not used, than the account is available in the sense of this specification. Allowed values: enabled, deleted, blocked |
| details | string , optional |
Specifications that might be provided by the ASPSP * characteristics of the account * characteristics of the relevant card |
| product | string , optional |
Product Name of the Bank for this account, proprietary definition |
| tariffs | string , optional |
Currently only supported for securities accounts: Text information on tariffs related to this securities account. |
| balances | array[object] , optional |
A balance of the account. |
| balanceType | string , required |
Type of balance. Allowed values: closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced |
| balanceAmount | object , required |
An amount with its currency. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| referenceDate | string , optional |
indicates the date of the balance Format: date |
| lastChangeDateTime | string , optional |
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. Format: date-time |
| creditLimitIncluded | boolean , optional |
A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable. |
| lastCommittedTransaction | string , optional |
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known. |
| currency | string , required |
Account currency |
| interest | array[object] , optional |
Currently only supported for savings accounts and loan accounts: A set of interest rates associated to this account, e.g. interests for savings or credits. |
| rate | array[object] , required |
An array of interest rates, which might apply to different amount ranges. |
| toAmount | object , optional |
Amount up to which the interest rate applies. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| fromAmount | object , optional |
Amount from which the interest rate applies. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| percentage | string , required |
The (signed) rate of the interest. Up to 20 significant figures. The decimal separator is a dot. Trailing zeroes must be truncated. Pattern: -?[0-9]{1,20}(\.[0-9]{0,19})? |
| type | string , optional |
Type of the interest. Currently, interests are distinguished between those with fixed rates ("FIXD") and those with rates derived from an index ("INDE"). Allowed values: FIXD, INDE |
| reason | string , optional |
Specifies the reason of the interest. Though arbitrary text is technically supported, it is recommended to use the following keywords with pre-defined meaning: * *arrears:*The addressed interest rate applies only in case of arrears. * *alternateRateMaximumOf:* The addressed alternate interest rate applies in cases where this rate implies a higher interest in a dedicated interest period than the regular interest rate provided without reason element. * *alternateRateMinimumOf:* The addressed alternate interest rate applies in case where this rate implies a lower interest in a dedicated interest period than the regular interest rate provided without reason element. ASPSPs may define further keywords and shall publish them in their documentation. |
| toDateTime | string , optional |
The date until this interest rate is applicable. If no exact time is applicable, 23:59:59 is chosen as time definition. Format: date-time |
| fromDateTime | string , optional |
The date from which this interest rate is applicable. If no exact time is applicable, 00:00:00 is chosen as time definition. Format: date-time |
| relatedIndices | array[object] , optional |
List of indices related to the interest rate. |
| index | string , optional |
Though arbitrary text is technically supported, it is recommended to use the following keywords: * "CPI" - customer Price Index * "FC" - foreign currency * "other" - for others, not clearly specified index relations. |
| exchangeRate | object , optional |
Intended for usage in case of index = "FC". |
| toAmount | object , optional |
Amount up to which the interest rate applies. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| fromAmount | object , optional |
Amount from which the interest rate applies. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| percentage | string , required |
The (signed) rate of the interest. Up to 20 significant figures. The decimal separator is a dot. Trailing zeroes must be truncated. Pattern: -?[0-9]{1,20}(\.[0-9]{0,19})? |
| rootIndexValue | string , optional |
A number (represented as a string) giving the basic index value which is the basis for the loan contract. |
| additionalInformation | string , optional |
Explanations e.g. to specify index = "other". |
| changeMechanism | string , optional |
An explanation of a mandated change mechanism. |
| ownerName | string , optional |
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. NOTE: This attribute is deprecated in later versions. |
| ownerNames | array[object] , optional |
List of owner names together with a role, where applicable. NOTE: This attribute is deprecated in later versions. |
| name | string , required |
Account owner name |
| role | string , optional |
The following proprietary codes are used: "owner", "legalRepresentative", "authorisedUser". |
| postalAddress | object , optional |
Information that locates and identifies a specific address, as defined by postal services. |
| room | string , optional |
Building room number. |
| floor | string , optional |
Floor or storey within a building. |
| country | string , optional |
Nation with its own government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| postBox | string , optional |
Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for. |
| postCode | string , optional |
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. |
| townName | string , optional |
Name of a built-up area, with defined boundaries, and a local government. *Usage Rule:* If address lines are not used, this attribute is mandatrory. |
| department | string , optional |
Identification of a division of a large organisation or building. |
| streetName | string , optional |
Name of a street or thoroughfare. |
| addressLines | array[string] , optional |
At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. *Remark:* For SEPA transactions this is further restricted to a maximum of 1 entry. |
| buildingName | string , optional |
Name of the building or house. |
| districtName | string , optional |
Identifies a subdivision within a country sub-division. |
| subDepartment | string , optional |
Identification of a sub-division of a large organisation or building. |
| buildingNumber | string , optional |
Number that identifies the position of a building on a street. |
| townLocationName | string , optional |
Specific location name within the town. |
| countrySubDivision | string , optional |
Identifies a subdivision of a country such as state, region, county. |
| contactDetails | object , optional |
Set of elements used to indicated how to contact the party. |
| name | string , optional |
|
| jobTitle | string , optional |
Title of the function. |
| faxNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| department | string , optional |
Identification of a division of a large organisation or building. |
| namePrefix | string , optional |
Specifies the terms used to formally address a person. Allowed values: DOCT, MADM, MISS, MIST, MIKS |
| phoneNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| emailAddress | string , optional |
Address for electronic mail (e-mail). |
| emailPurpose | string , optional |
Purpose for which an email address may be used. |
| mobileNumber | string , optional |
pattern \+[0-9]{1,3}-[0-9()+\-]{1,30} |
| responsibility | string , optional |
Role of a person in an organisation. |
| preferredMethod | string , optional |
Preferred method used to reach the contact. Allowed values: LETT, MAIL, PHON, FAXX, CELL |
| identification | object , optional |
Unique and unambiguous identification of a party |
| privateId | object , optional |
A scheme name defined in a proprietary way. |
| others | array[object] , optional |
Unique identification of a person, as assigned by an institution, using an identification scheme. Shall be used if none of the above attributes is used. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of a oersib. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: ARNU, CCPT, CUST, DRLC, EMPL, NIDN, SOSE, TELE, TXID, POID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| birthDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| cityOfBirth | string , optional |
|
| countryOfBirth | string , optional |
ISO 3166-1 alpha-2 country code. |
| provinceOfBirth | string , optional |
|
| organisationId | object , optional |
An entry provided by an external ISO code list |
| lei | string , optional |
Legal Entity Identifier. |
| anyBIC | string , optional |
A code allocated to a business entity or to a financial institution by a Registration Authority under an international identification scheme. |
| others | array[object] , optional |
Unique identification of an organisation, as assigned by an institution, using an identification scheme. |
| issuer | string , optional |
Issuer of the identification |
| identification | string , required |
Unique and unambiguous identification of an organisation. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list Allowed values: BANK, CBID, CHID, CINC, COID, CUST, DUNS, EMPL, GS1G, SREN, SRET, TXID, BDID, BOID |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| countryOfResidence | string , optional |
Country in which a person resides. In case of a company, it is the country from which the affairs of that company are directed. Constraints: The code is checked against the list of country names obtained from the United Nations (ISO 3166 Alpha-2 code). |
| resourceId | string , required |
This is the data element to be used in the path when retrieving data from a dedicated account. |
| displayName | string , optional |
Name of the account as defined by the PSU within online channels. |
| relatedDates | object , optional |
Currently only supported for securities accounts: Text information on tariffs related to this securities account. |
| contractEndDate | string , optional |
End of the account contract. Format: date |
| contractStartDate | string , optional |
Start of the account contract. Format: date |
| contractAvailabilityDate | string , optional |
Next Date where money can be taken off a saving account without loss of interest, if initiated now (in case of a saving account). Next Date where a loan can be fully repaid without any extra fee. Format: date |
| applicableFees | array[object] , optional |
Currently only supported for securities accounts: Array of elements, each representing one fee (rule) that is individually applicable for this Securities account. If, for example, an ASPSP applies a standard "managementFee" X, but the consumer negotiated a discount D, an element should represent (X-D), but neither X nor D. |
| feeRules | array[object] , required |
Array of fee rules. Each rule represents ow the amount of the fee is determined either explicitly by stating the amount or implicitly by providing a percentage, minimum and maximum amount. This array will usually only contain one entry to represent the whole rule. Only in the case of the fee being calculated as a tiered percentage, several entries are included to represent the several tiers of the fee rule. |
| amount | object , optional |
Amount of the fee. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| percentage | string , optional |
Percentage of the fee. Up to 20 significant figures. The decimal separator is a dot. Trailing zeroes must be truncated.Fee as a percentage. Pattern: -?[0-9]{1,20}(\.[0-9]{0,19})? |
| toBaseAmount | object , optional |
To be used for fees where a tiered percentage is used to calculate the fee relative to an implicitly defined base amount (such as a transaction's volume being the base amount for a courtage). The range of one tier is defined as all applicable entities with base amounts X and fromBaseAmount \u2264 X \u2264 toBaseAmount. In any array of fee rules, only one of these entries may be missing the "fromBaseAmount" element (indicating that the rule represented by this entry is used without a lower bound to the base amount) and only one entry may be missing the "toBaseAmount" element (indicating that the rule represented by this entry is applied without an upper limit to the base amount). In cases, where the fee is not calculated as a tiered percentage, only one entry in array "feeRules" is included. This entry must be missing both subelements "fromBaseAmount" and "toBaseAmount". |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| maximumAmount | object , optional |
Maximum amount of the fee in each billing / for each billed event period if applicable. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| minimumAmount | object , optional |
Minimum amount of the fee in each billing period / for each billed event if applicable. |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| fromBaseAmount | object , optional |
To be used for fees where a tiered percentage is used to calculate the fee relative to an implicitly defined base amount (such as a transaction's volume being the base amount for a courtage). The range of one tier is defined as all applicable entities with base amounts X and fromBaseAmount \u2264 X \u2264 toBaseAmount. In any array of fee rules, only one of these entries may be missing the "fromBaseAmount" element (indicating that the rule represented by this entry is used without a lower bound to the base amount) and only one entry may be missing the "toBaseAmount" element (indicating that the rule represented by this entry is applied without an upper limit to the base amount). In cases, where the fee is not calculated as a tiered percentage, only one entry in array "feeRules" is included. This entry must be missing both subelements "fromBaseAmount" and "toBaseAmount". |
| amount | string , required |
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 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| typeCode | string , optional |
Type of the fee as a code. Might be adjusted in the future based on market experience. Allowed values: transactionFee, brokerageFee, managementFee, courtage, custodyFee, exchangeFee, thirdPartyFee, otherFee |
| applicableTo | string , optional |
Last date, when this fee is applicable. If not present, the fee is applicable indefinitely. Format: date |
| applicableFrom | string , optional |
First date, when this fee is applicable. If not present, the fee is applicable starting with the creation of this account / the latest reporting date supported by the ASPSP. Format: date |
| typeProprietary | string , optional |
Type of the fee as a proprietary string. |
| additionalInformation | string , optional |
|
| linkedAccounts | string , optional |
This data attribute is a field, where an ASPSP can name a cash account associated to the described account, e.g. in case of a securities account or a card account. |
| cashAccountType | string , optional |
ExternalCashAccountType1Code from ISO 20022 Allowed values: CACC, CARD, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, VACC, NFCA |
| guaranteeInvolved | boolean , optional |
Currently only supported for loan accounts: Is set to true in case of specific collaterals where a guarantee of payment of the loan is given by a different person. |
| collateralsInvolved | boolean , optional |
Currently only supported for loan accounts: Is set to true if a collateral is involved securing the loan (e.g. security deposit, physical collaterals like houses, cars). More information might be provided under the "details" attribute. |
| _links | object , optional |
Links to the account, which can be directly used for retrieving account information from this dedicated account. Links to "balances" and/or "transactions". Links to "orders" and/or "positions" in the case of securities accounts. These links are only supported, when the corresponding consent has been already granted. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
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. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). Allowed values: FORMAT_ERROR, PARAMETER_NOT_CONSISTENT, PARAMETER_NOT_SUPPORTED, SERVICE_INVALID, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED, RESOURCE_BLOCKED, TIMESTAMP_INVALID, PERIOD_INVALID, SCA_METHOD_UNKNOWN, SCA_INVALID, CONSENT_TYPE_NOT_SUPPORTED, SESSIONS_NOT_SUPPORTED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
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. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). Allowed values: CERTIFICATE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, ROLE_INVALID, PSU_CREDENTIALS_INVALID, CORPORATE_ID_INVALID, CONSENT_INVALID, CONSENT_EXPIRED, TOKEN_UNKNOWN, TOKEN_INVALID, TOKEN_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
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. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). Allowed values: SERVICE_BLOCKED, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
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. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). Allowed values: SERVICE_INVALID Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
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. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|