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 statements
/v2/account-statements
This call retrieves statements for all current accounts that the PSU has access to under the related PSU-ID and has provided consent.
Query parameters
| Parameter | Type | Description |
|---|---|---|
| fromDateTime | string , optional |
Date and time at which the period of the account statement starts. The ASPSP is not mandated to interpret the time fraction of the timestamp. In this case, the validation would use only the presented date and provide statements accordingly. If the API Client wants to retrieve the statements for the whole day, the value 00:00:00 shall be used as time fraction in the timestamp. In case no starting period has been specified, the retrieved account statement shall contain the statement of the current period, where the chosen period is implementation specific. Furthermore, the ASPSP may mandate the usage of this query parameter. Example: Format: date-time |
| toDateTime | string , optional |
Date and time at which the period of account statement ends. The ASPSP is not mandated to interpret the time fraction of the timestamp. In this case, the validation would use only the presented date and provide statements accordingly. If the API Client wants to retrieve the statements for the whole day, the value 24:00:00 shall be used as time fraction in the timestamp. In case no ending period has been specified, the retrieved account statement shall contain the statement from the starting point of time till the date/time of the request. Example: Format: date-time |
| cardBrand | string , optional |
This attribute filters transactions according to their corresponding card brand. Only to be supported in a scenario, where this is used as statements e.g. of card acquirers towards merchants.. Example: Allowed length: max: 35 |
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 |
| 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 |
|---|---|---|
| messageId | string , required |
Point to point reference, as assigned by the sending party, to unambiguously identify the batch of transactions. |
| statement | array[object] , required |
Usage Rule: For /accounts/{account-id}/statements only a single statement element will be provided. For /account-statements there will be one statement element for each account which is addressable by the PSU under the related consent. |
| entry | array[object] , required |
One array element specifies an entry in the report. |
| amount | object , required |
transactionAmount for transactions |
| 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 |
| charges | object , optional |
Provides information on the charges, pre-advised or included in the entry amount. |
| record | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Charges Record" for more details. |
| tax | object , optional |
See document "openFinance API Framework Data Dictionary", section "Tax" for more details. |
| rate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| amount | object , optional |
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 |
| identification | string , optional |
|
| rate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| agent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| amount | 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 |
| bearer | string , optional |
ChargeBearerType1Code Allowed values: DEBT, CRED, SHAR, SLEV |
| typeCode | string , optional |
ExternalChargeType1code Allowed values: BRKF, BTCH, COMM, SUMM, AMND, CFEE, CLEF, INVS, INTE, NSTP, DEBT, TELE, ACCM, RECH |
| chargesIncludedIndicator | boolean , optional |
Indicates whether the charge should be included in the amount or is added as pre-advice. |
| totalChargesAndTaxAmount | 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 |
| interest | object , optional |
Provides details of the interest amount included in the entry amount. |
| record | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Interest Record" for more details. |
| tax | object , optional |
- $ref: '#/components/schemas/tax' |
| rate | object , optional |
See document "openFinance API Framework Data Dictionary", section "Rate" for more details. |
| typeOther | string , optional |
|
| validityRange | object , optional |
See document "openFinance API Framework Data Dictionary", section "Amount Range" for more details. |
| toAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| fromAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| equalAmount | object , optional |
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 |
| fromToAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "From To Amount Range" for more details. |
| toAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| fromAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| notEqualAmount | object , optional |
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 |
| typePercentage | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| amount | 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 |
| reason | string , optional |
|
| typeCode | string , optional |
InterestType1code Allowed values: INDY, OVRN |
| toDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| fromDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| totalInterestAndTaxAmount | object , optional |
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 |
| valueDate | string , optional |
Date at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Format: date |
| statusCode | string , required |
Status of an entry on the books of the account servicer. Allowed values: BOOK, FUTR, INFO, PDNG |
| bookingDate | string , optional |
Date when an entry is posted to an account on the account servicer's books. Format: date |
| availability | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Availability" for more details. |
| amount | 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 |
| actualDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| numberOfDays | integer , optional |
|
| entryDetails | object , optional |
Deviation from ISO20022, since Array is never used. |
| batch | object , optional |
Provides details on batched transactions. |
| messageId | string , optional |
Point to point reference, as assigned by the sending party, to unambiguously identify the batch of transactions. |
| totalAmount | object , optional |
Total amount of money reported in the batch entry. |
| 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 |
| numberOfTransactions | integer , optional |
Number of individual transactions included in the batch. |
| paymentInformationId | string , optional |
Unique identification, as assigned by a sending party, to unambiguously identify the payment information group within the message. |
| transactionDetails | array[object] , optional |
Provides information on the underlying transaction(s). |
| tax | object , optional |
See document "openFinance API Framework Data Dictionary", section "Details Tax" for more details. |
| date | string , optional |
Date by which the tax is due. Format: date |
| debtor | object , optional |
Party on the debit side of the transaction to which the tax applies. |
| taxId | string , optional |
Tax identification number of the debtor |
| taxType | string , optional |
Type of the tax payer. |
| authorisation | object , optional |
Details of the authorised tax paying party. |
| name | string , optional |
Name of the debtor or their representatives. |
| title | string , optional |
Title of position of the debtor or their representatives. |
| registrationId | string , optional |
Unique identification, assigned by an organization, to identify a party. |
| method | string , optional |
Method underlying how the tax payment is performed. |
| record | array[object] , optional |
Record of the tax details. |
| type | string , optional |
High level code to identify the type of the tax details. |
| period | object , optional |
Provides details on the period of time of the related tax payment. |
| type | string , optional |
Identification of the period related to the tax payment. Allowed values: MM01, MM02, MM03, MM04, MM05, MM06, MM07, MM08, MM09, MM10, MM11, MM12, QTR1, QTR2, QTR3, QTR4, HLF1, HLF2 |
| year | string , optional |
Year of the related tax payment. Format: date |
| fromToDate | string , optional |
Start and end date of the tax report. Format: date-time |
| category | string , optional |
Specifies the tax code as published by the tax authority. |
| formsCode | string , optional |
Identifies on which template the tax report to be provided in a coded form. |
| taxAmount | object , optional |
Provides information of the amount of the tax record. |
| rate | object , optional |
Rate used to calculate the tax. |
| typeOther | string , optional |
|
| validityRange | object , optional |
See document "openFinance API Framework Data Dictionary", section "Amount Range" for more details. |
| toAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | object , required |
An amount with its currency. |
| fromAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | object , required |
An amount with its currency. |
| equalAmount | object , optional |
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 |
| fromToAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "From To Amount Range" for more details. |
| toAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| fromAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| notEqualAmount | object , optional |
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 |
| typePercentage | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| details | object , optional |
Provides details on the tax period and amount |
| 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 |
| totalAmount | object , optional |
Total amount as a result of the calculation of the tax record. |
| taxableBaseAmount | object , optional |
Amount of money on which the tax is based. |
| 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 |
| debtorStatus | string , optional |
Code provided by local authority to identify the status of the party that has drawn up the settlement document. |
| certificateId | string , optional |
Identification number of the tax report as assigned by the taxing authority. |
| categoryDetails | string , optional |
Provides further details on the tax category code. |
| additionalInformation | string , optional |
Further details of the tax record. |
| creditor | object , optional |
Party on the credit side of the transaction to which the tax applies. |
| taxId | string , optional |
Tax identification number of the creditor |
| taxType | string , optional |
Type of the tax payer. |
| registrationId | string , optional |
Unique identification, assigned by an organization, to identify a party. |
| sequenceNumber | integer , optional |
Sequential number of the tax report. |
| totalTaxAmount | object , optional |
Total amount of money as a result of the calculation of the tax. |
| 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 |
| referenceNumber | string , optional |
Tax reference information that is specific to a tax agency. |
| administrationZone | string , optional |
The territorial part of the country to which the tax is related. |
| totalTaxableBaseAmount | object , optional |
Total amount of money on which the tax is based. |
| 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 |
| amount | object , required |
transactionAmount for transactions |
| 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 |
| charges | object , optional |
See document "openFinance API Framework Data Dictionary", section "Charges" for more details. |
| record | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Charges Record" for more details. |
| tax | object , optional |
See document "openFinance API Framework Data Dictionary", section "Tax" for more details. |
| rate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| amount | object , optional |
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 |
| identification | string , optional |
|
| rate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| agent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| amount | 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 |
| bearer | string , optional |
ChargeBearerType1Code Allowed values: DEBT, CRED, SHAR, SLEV |
| typeCode | string , optional |
ExternalChargeType1code Allowed values: BRKF, BTCH, COMM, SUMM, AMND, CFEE, CLEF, INVS, INTE, NSTP, DEBT, TELE, ACCM, RECH |
| chargesIncludedIndicator | boolean , optional |
Indicates whether the charge should be included in the amount or is added as pre-advice. |
| totalChargesAndTaxAmount | 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 |
| interest | object , optional |
See document "openFinance API Framework Data Dictionary", section "Transaction Interest" for more details. |
| record | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Interest Record" for more details. |
| tax | object , optional |
- $ref: '#/components/schemas/tax' |
| rate | object , optional |
See document "openFinance API Framework Data Dictionary", section "Rate" for more details. |
| typeOther | string , optional |
|
| validityRange | object , optional |
See document "openFinance API Framework Data Dictionary", section "Amount Range" for more details. |
| toAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| fromAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| equalAmount | object , optional |
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 |
| fromToAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "From To Amount Range" for more details. |
| toAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | object , required |
An amount with its currency. |
| fromAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | object , required |
An amount with its currency. |
| notEqualAmount | object , optional |
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 |
| typePercentage | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| amount | 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 |
| reason | string , optional |
|
| typeCode | string , optional |
InterestType1code Allowed values: INDY, OVRN |
| toDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| fromDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| totalInterestAndTaxAmount | object , optional |
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 |
| references | object , optional |
Might contain the payment identification attributes endToEndId as well as the new UETR field. In addition it is including e.g. accountSer-vicerReference, mandateId, checkNumber |
| uetr | string , optional |
Universally unique identifier to provide an end-to-end reference of a payment transaction. It is recommended to use time-based version (version 1) and variant 8,9,a or b of the UUID as defined in [RFC4122] for UUID fields such as uetr. Format: uuid |
| mandateId | string , optional |
direct debit related mandate. |
| messageId | string , optional |
|
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| processingId | string , optional |
Identification of the securities transaction assigned by the processor of the instruction other than the securities account owner, the securities account servicer and the market infrastructure. |
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| transactionId | string , optional |
|
| paymentInformationId | string , optional |
|
| clearingSystemReference | string , optional |
Unique reference as defined by clearing system. |
| accountServicerReference | string , optional |
|
| accountOwnerTransactionId | string , optional |
Unambiguous identification of the securities transaction as known by the securities account owner (or the instructing party managing the account). |
| accountServicerTransactionId | string , optional |
Unambiguous identification of the securities transaction as known by the securities account servicer. |
| marketInfrastructureTransactionId | string , optional |
Identification of a securities transaction assigned by a market infrastructure other than a central securities depository, for example, Target2-Securities. |
| cashDeposit | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Cash Deposit" for more details. |
| amount | 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 |
| numberNotes | string , required |
Only numeric text. |
| noteDenomination | 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 |
| purposeCode | string , optional |
ISO 20022 purpose code for the transaction. Allowed values: BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT |
| availability | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Availability" for more details. |
| amount | 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 |
| actualDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| numberOfDays | integer , optional |
|
| relatedDates | object , optional |
See document "openFinance API Framework Data Dictionary", section "Related Dates" for more details. |
| endDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| startDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| tradeDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| acceptanceDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| transactionDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| interbankSettlementDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| tradeActivityContractualSettlementDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| relatedPrice | object , optional |
See document "openFinance API Framework Data Dictionary", section "Related Price" for more details. |
| proprietary | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Proprietary Price" for more details. |
| type | string , required |
|
| price | 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 |
| dealPriceValueRate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| dealPriceTypeYielded | boolean , optional |
|
| dealPriceValueAmount | object , optional |
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 |
| dealPriceTypeValueType | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Allowed values: DISC, PEM, PARV |
| amountDetails | object , optional |
Amount details of the transaction. |
| instructedAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| transactionAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| counterValueAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| announcedPostingAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| relatedAgents | object , optional |
See document "openFinance API Framework Data Dictionary", section "Related Agents" for more details. |
| debtorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| issuingAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| creditorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| receivingAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| deliveringAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| instructedAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| settlementPlace | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| instructingAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| intermediaryAgent1 | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| intermediaryAgent2 | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| intermediaryAgent3 | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| relatedParties | object , optional |
See document "openFinance API Framework Data Dictionary", section "Related Parties" for more details. |
| debtor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| creditor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| debtorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| tradingParty | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| creditorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| debtorAccount | object , optional |
Identifies an account. Use iban for payment accounts; currency narrows a multi-currency account. |
| pan | string , optional |
Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements. |
| bban | string , optional |
BBAN of the account. This data elements is used for payment accounts which have no IBAN. |
| iban | string , optional |
International Bank Account Number. |
| name | string , optional |
Name 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 |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| proxy | object , optional |
A proxy that identifies the account, such as a phone number or email. |
| typeCode | string , optional |
Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID |
| identification | string , required |
|
| typeProprietary | string , optional |
|
| msisdn | string , optional |
An alias to access a payment account via a registered mobile phone number. |
| currency | string , optional |
ISO 4217 Alpha 3 currency code |
| servicer | object , optional |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| typeCode | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. 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 |
| maskedPan | string , optional |
Primary Account Number (PAN) of a card in a masked form. |
| typeProprietary | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. |
| ultimateDebtor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| creditorAccount | object , optional |
Identifies an account. Use iban for payment accounts; currency narrows a multi-currency account. |
| pan | string , optional |
Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements. |
| bban | string , optional |
BBAN of the account. This data elements is used for payment accounts which have no IBAN. |
| iban | string , optional |
International Bank Account Number. |
| name | string , optional |
Name 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 |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| proxy | object , optional |
A proxy that identifies the account, such as a phone number or email. |
| typeCode | string , optional |
Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID |
| identification | string , required |
|
| typeProprietary | string , optional |
|
| msisdn | string , optional |
An alias to access a payment account via a registered mobile phone number. |
| currency | string , optional |
ISO 4217 Alpha 3 currency code |
| servicer | object , optional |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| typeCode | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. 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 |
| maskedPan | string , optional |
Primary Account Number (PAN) of a card in a masked form. |
| typeProprietary | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. |
| initiatingParty | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| ultimateCreditor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| tradingPartyAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| ultimateDebtorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| initiatingPartyAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| ultimateCreditorAgent | object , optional |
See document "openFinance API Framework Data Dictionary", section "Agent Description" for more details. |
| branchIdentificationId | string , optional |
Unique and unambiguous identification of a branch of a financial institution. |
| financialInstitutionId | object , required |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| branchIdentificationName | string , optional |
Name by which an agent is known and which is usually used to identify that agent. |
| cardTransaction | object , optional |
See document "openFinance API Framework Data Dictionary", section "Card Transaction" for more details. |
| card | object , optional |
See document "openFinance API Framework Data Dictionary", section "Card Type" for more details. |
| cardBrand | string , optional |
|
| maskedPAN | string , optional |
|
| cardHolderName | string , optional |
|
| transaction | object , optional |
See document "openFinance API Framework Data Dictionary", section "Card Transaction Details" for more details. |
| poiId | string , optional |
Identification of the POI (Point Of Interaction) performing the transaction. |
| paymentContext | object , optional |
Context of the card payment transaction. |
| cardPresent | boolean , optional |
|
| cardDataEntryMode | string , optional |
See document "openFinance API Framework Data Dictionary", section "Card Data Entry Mode" for more details. Allowed values: CICC, ECTL, MGST, PHYS, BRCD |
| sequenceNumber | string , optional |
|
| saleReferenceId | string , optional |
Global reference of the sale transaction for the sale system. |
| transactionType | string , optional |
Type of transaction being undertaken for the main service. Allowed values: AGGR, DCCV, GRTT, INSP, LOYT, NRES, PUCO, RECP, SOAF, UNAF, VCAU |
| authorisationCode | string , optional |
Value assigned by the authorising party. |
| transactionDateTime | string , optional |
Local date and time of the transaction assigned by the POI (Point Of Interaction). Format: date-time |
| corporateAction | object , optional |
See document "openFinance API Framework Data Dictionary", section "Corporate Action" for more details. |
| eventId | string , required |
|
| eventType | string , required |
|
| relatedQuantities | array[object] , optional |
Set of elements used to identify the related quantities, such as securities, in the underlying transaction. |
| quantity | object , optional |
See document "openFinance API Framework Data Dictionary", section "Quantity" for more details. |
| unit | number , optional |
Format: double |
| faceAmount | object , optional |
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 |
| amortisedValue | object , optional |
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 |
| proprietary | object , optional |
See document "openFinance API Framework Data Dictionary", section "Proprietary Quantity" for more details. |
| type | string , required |
|
| quantity | string , required |
|
| originalAndCurrentFaceAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Original and Current Face Amount" for more details. |
| faceAmount | object , required |
Quantity expressed as an amount representing the face amount, that is, the principal of a debt instrument. |
| 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 |
| amortisedValue | object , required |
Quantity expressed as an amount representing the current amortised face amount of a bond, for example, a periodic reduction/increase of a bond's principal amount. |
| 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 |
| returnInformation | object , optional |
See document "openFinance API Framework Data Dictionary", section "Payment Return Reason" for more details. |
| originator | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| reasonCode | string , optional |
ExternalReturnReason1Code Allowed values: AC01, AC02, AC03, AC04, AC06, AC07, AC13, AC14, AC15, AC16, AC17, AG01, AG02, AG07, AGNT, AM01, AM02, AM03, AM04, AM05, AM06, AM07, AM09, AM10, ARDT, BE01, BE04, BE05, BE06, BE07, BE08, BE10, BE11, BE16, BE17, CN01, CNOR, CNPC, CURR, CUST, DC04, DNOR, DS28, DT01, DT02, DT04, DUPL, ED01, ED03, ED05, EMVL, ERIN, FF03, FF04, FF05, FF06, FF07, FOCR, FR01, FRTR, G004, MD01, MD02, MD05, MD06, MD07, MS02, MS03, NARR, NOAS, NOCM, NOOR, PINL, RC01, RC03, RC04, RC07, RC08, RC11, RF01, RR01, RR02, RR03, RR04, RR05, RR06, RR07, RR08, RR09, RR11, RR12, RUTA, SL01, SL02, SL11, SL12, SL13, SL14, SP01, SP02, SVNR, TM01, TRAC, UPAYY |
| reasonProprietary | string , optional |
|
| additionalInformation | string , optional |
|
| originalBankTransactionCode | string , optional |
ISO 20022 bank transaction code. |
| originalBankTransactionCodeIssuer | string , optional |
|
| originalBankTransactionCodeProprietary | string , optional |
|
| safekeepingAccount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Safekeeping Account" for more details. |
| name | string , optional |
|
| typeId | string , optional |
|
| typeIssuer | string , optional |
|
| identification | string , required |
|
| typeSchemeName | object , optional |
- $ref: '#/components/schemas/Max35Text' |
| bankTransactionCode | string , optional |
ISO 20022 bank transaction code. |
| localInstrumentCode | string , optional |
Local instrument, per the ISO 20022 external code list. Allowed values: DDMC, DDMP, DDMU, BPA, IPA, TRF, 82, 83, CPP, RTR, GST, DDT, RDD, CHN, STR, SDD, SRT, SRD, SCN, SGT, CARD, 05, 04, ISE, BSE, 58, 19, ASTI, BACP, MANP, SBTI, 85, 08, 89, 60, RIBA, RIDO, RIDV, IDEAL, INSTNT01, INSTTC01, INSTIDEAL, INSTNT01IDEAL, INSTTC01IDEAL, NLDO, NLUP, SDN, ACCEPT, ICMC, NLGOV, IN, ONCL, PERI, SDCL, DDNR, DDFA, CORE, B2BAMIPM, B2B, CR1AMIPM, CORAMIPM, COR1, FADAMIPM, CLSCCPERX, CLSCCPLCH, INST, ADD, UDD, CCI, IAT, CCD, CTX, PPD, CIE, RCK, ARC, WEB, POP, POS, TEL, ITP, CTP, MDP, IMD, SOP, FDP |
| financialInstrumentId | object , optional |
See document "openFinance API Framework Data Dictionary", section "Financial Instrument" for more details. |
| isin | string , optional |
ISIN of the financial Instrument. The primitive ISIN type is defined as in ISO20022. |
| name | string , optional |
Name of the financial instrument. |
| otherId | object , optional |
If an ISIN is not available, the ASPSP may instead include an identification by other means. |
| suffix | string , optional |
Identifies the suffix of the security identification. |
| typeCode | string , optional |
Unique and unambiguous identification source, as assigned via a pre-determined code list. Allowed values: BELC, BLOM, CCCD, CMED, COMM, CTAC, CUSP, FIGC, FIGG, FIGI, ISDU, ISDX, LCHD, OCCS, OPRA, RCMD, RICC, SEDL, SICC, TIKR, VALO, WKNR |
| identification | string , required |
Identification of a security. |
| typeProprietary | string , optional |
Unique and unambiguous identification source using a proprietary identification type. |
| description | string , optional |
Textual description of the financial instrument. Usage rule: description is considered to be the last choice to describe the financial instrument, in case neither isin nor at least one instance of otherId is present. |
| normalisedPrice | object , optional |
Price per unit of the financial instrument in case of a price amount. Percentage price otherwise. If used in the context of a securities transaction, the price here shall indicate the applied price (without fees) for the trade. Note: Not applicable to account statement |
| amount | object , optional |
If the price is evaluated as an amount, amount of the price in its respective 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 |
| priceDate | string , optional |
Date of the evaluation of this price. Format: date |
| priceType | string , optional |
Type of the price. Allowed values: BIDE, OFFR, NAVL, CREA, CANC, INTE, SWNG, MIDD, RINV, SWIC, MRKT, INDC, DDVR, ACTU |
| percentage | string , optional |
Percentage of the price with (optional) fractional digits. Up to 20 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Trailing zeroes must be truncated. Pattern: -?[0-9]{1,20}(\.[0-9]{0,19})? |
| description | string , optional |
Additional description of the source of price. E.g., if the source of price indicates a local market, the ASPSP can include the local market's name in this field. |
| exchangeRates | array[object] , optional |
Relevant exchange rates for the determined price. |
| exchangeRate | string , required |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. |
| unitCurrency | string , required |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , required |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , required |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , required |
Currency into which an amount is to be converted in a currency conversion. |
| contractIdentification | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| priceDateTime | string , optional |
Date and time of the evaluation of this price. Format: date-time |
| sourceOfPrice | object , optional |
Indicates the source of the respective price. |
| mic | string , optional |
MIC of the market that constitutes the source of the price. If the "type" indicates local Market (Code: "LMAR"), the identification of the market should additionally be included in either attribute "mic" or attribute "marketIdentifierProprietary". |
| type | string , required |
Type of the market that constitutes the source of the price. Allowed values: FUND, LMAR, THEO, VEND |
| marketIdentifierProprietary | string , optional |
Proprietary identifier of the market that constitutes the source of the price. If the "type" indicates local Market (Code: "LMAR"), the identification of the market should additionally be included in either attribute "mic" or attribute "marketIdentifierProprietary". |
| bankTransactionCodeIssuer | string , optional |
Issuer of the proprietary bank transaction code. |
| localInstrumentProprietary | string , optional |
|
| relatedRemittanceInformation | array[object] , optional |
Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain. |
| remittanceIdentification | string , optional |
|
| remittanceLocationDetails | array[object] , optional |
Set of elements used to provide information on the location and/or delivery of the remittance information |
| method | string , required |
See document "openFinance API Framework Data Dictionary", section "Method Code" for more details. Allowed values: FAXI, EDIC, URID, EMAL, POST, SMSM |
| postalAddress | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| electronicAddress | string , optional |
Electronic address to which an agent is to send the remittance information. |
| bankTransactionCodeProprietary | string , optional |
|
| remittanceInformationStructured | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Remittance Reports" for more details. |
| invoicee | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| invoicer | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| identification | object , optional |
Identification of the 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. |
| additionalPartyInformation | object , optional |
Only supported in extended services for creditor related parties, if at all. *NOTE:* This information will be neither put to the related interbank payment nor to account reports/statements and might only be used to display related information to the PSU during potential authorisation processes. |
| logoURL | string , optional |
A hyperlink to the logo of the party. |
| tradeName | string , optional |
Trade name of the related party. For display to the PSU only. |
| geoLocation | string , optional |
Geographic location as latitude and longitude. |
| merchantCategoryCode | string , optional |
Merchant Category Code as assigned by ISO: |
| referredDocumentInformation | array[object] , optional |
Set of elements used to identify the documents referred to in the remittance information. |
| number | string , optional |
Unique and unambiguous identification of the referred document. |
| typeCode | string , optional |
Specifies the type of referred document, provided as code. Allowed values: MSIN, CNFA, DNFA, CINV, CREN, DEBN, HIRI, SBIN, CMCN, SOAC, DISP, BOLD, VCHR, AROI, TSUT, PUOR |
| typeIssuer | string , optional |
Issuer of the document type. |
| relatedDate | string , optional |
Date associated with the referred document. Format: date |
| typeProprietary | string , optional |
Specifies the type of referred document, provided in proprietary encoding. |
| creditorReferenceInformation | object , optional |
Reference information provided by the creditor to allow the identification of the underlying documents. |
| reference | string , required |
The actual reference. |
| referenceIssuer | string , optional |
Issuer of the reference. |
| referenceTypeCode | string , optional |
Type of the reference, provided as code. Allowed values: RADM, RPIN, FXDR, DISP, PUOR, SCOR |
| referenceTypeProprietary | string , optional |
Type of the reference, provided in proprietary encoding. |
| additionalRemittanceInformation | array[string] , optional |
Additional information to be displayed to the PSU e.g. within authorisation processes. This will not be used in related interbank payments. |
| additionalTransactionInformation | string , optional |
|
| remittanceInformationUnstructured | array[string] , optional |
|
| bankTransactionCodeproprietaryIssuer | string , optional |
Issuer of the proprietary bank transaction code. |
| amountDetails | object , optional |
Provides information on the original amount. |
| instructedAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| transactionAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| counterValueAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| announcedPostingAmount | object , optional |
An amount with optional exchange details. |
| 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 |
| contractId | string , optional |
Unique identification to unambiguously identify the foreign exchange contract. |
| exchangeRate | string , optional |
Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Note: If this field is present, then also the field sourceCurrency must be provided. |
| unitCurrency | string , optional |
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1EUR = xxxCUR, the unit currency is EUR. |
| quotationDate | string , optional |
Date at which an exchange rate is quoted. Format: date |
| sourceCurrency | string , optional |
Currency from which an amount is to be converted in a currency conversion. |
| targetCurrency | string , optional |
Currency into which an amount is to be converted in a currency conversion. |
| valueDateTime | string , optional |
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit entry. Format: date-time |
| entryReference | string , optional |
Unicque reference for the entry. |
| bookingDateTime | string , optional |
Date and time when an entry is posted to an account on the account servicer's books. Format: date-time |
| cardTransaction | object , optional |
Provides details of the card transaction included in the entry amount, when globalised by the account servicer. |
| card | object , optional |
See document "openFinance API Framework Data Dictionary", section "Card Type" for more details. |
| cardBrand | string , optional |
|
| maskedPAN | string , optional |
|
| cardHolderName | string , optional |
|
| transaction | object , optional |
See document "openFinance API Framework Data Dictionary", section "Card Transaction Details" for more details. |
| poiId | string , optional |
Identification of the POI (Point Of Interaction) performing the transaction. |
| paymentContext | object , optional |
Context of the card payment transaction. |
| cardPresent | boolean , optional |
|
| cardDataEntryMode | string , optional |
See document "openFinance API Framework Data Dictionary", section "Card Data Entry Mode" for more details. Allowed values: CICC, ECTL, MGST, PHYS, BRCD |
| sequenceNumber | string , optional |
|
| saleReferenceId | string , optional |
Global reference of the sale transaction for the sale system. |
| transactionType | string , optional |
Type of transaction being undertaken for the main service. Allowed values: AGGR, DCCV, GRTT, INSP, LOYT, NRES, PUCO, RECP, SOAF, UNAF, VCAU |
| authorisationCode | string , optional |
Value assigned by the authorising party. |
| transactionDateTime | string , optional |
Local date and time of the transaction assigned by the POI (Point Of Interaction). Format: date-time |
| reversalIndicator | boolean , optional |
Idicates whether or not the entry is the result of a reversal. |
| bankTransactionCode | string , optional |
Set of elements used to fully identify the type of underlying transaction resulting in an entry. |
| commisionWaverIndicator | boolean , optional |
Indicates whether the transaction is exempt from commission. |
| accountServicerReference | string , optional |
Unique reference as assigned by the account servicing institution to unambiguously identify the entry. |
| bankTransactionCodeIssuer | string , optional |
Issuer of the proprietary bank transaction code. |
| technicalInputChannelCode | string , optional |
Channel used to technically input the instruction related to the entry. Allowed values: FAXI, PAPR, TAPE, WEBI |
| additionalEntryInformation | string , optional |
gibt es nicht bei Transactions |
| additionalInformationIndicator | object , optional |
Indicates whether the underlying transaction details are provided through a separate message, as in the case of aggregate bookings. |
| messageIdentification | string , optional |
Specifies the identification of the message that will be used to provide additional details. |
| messageNameIdentification | string , optional |
Specifies the message name identifier of the message that will be used to provide additional details. |
| bankTransactionCodeProprietary | string , optional |
Set of proprietarily defined elements used to fully identify the type of underlying transaction resulting in an entry. |
| account | object , required |
Unambiguous identification of the account to which credit and debit entries are made. |
| iban | string , optional |
International Bank Account Number. |
| 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. |
| balance | array[object] , required |
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account at a specific point in time. |
| date | string , optional |
indicates the date of the balance Format: date |
| amount | 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 |
| dateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| typeCode | string , required |
short ISO Code Allowed values: CLAV, CLBD, FWAV, INFO, ITAV, ITBD, OPAV, OPBD, PRCD, XPCD |
| creditLine | object , optional |
See document "openFinance API Framework Data Dictionary", section "Credit Line" for more details. |
| date | string , optional |
Date of the credit line provided, when multiple credit lines may be provided. Format: date |
| amount | object , optional |
amount of the credit line. |
| 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 |
| dateTime | string , optional |
Date/Time of the credit line provided, when multiple credit lines may be provided. Format: date-time |
| included | boolean , required |
|
| typeCode | string , optional |
short ISO Code |
| typeProprietary | string , optional |
|
| subTypeCode | string , optional |
ExternalBalanceSubtype1Code Allowed values: ADJT, BCUR, BLCK, BLKD, DLOD, EAST, FCOL, FCOU, FORC, FUND, INTM, LCUR, LRLD, NOTE, PDNG, PIPO, PRAV, RESV, SCOL, SCOU, THRE |
| availability | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Availability" for more details. |
| amount | 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 |
| actualDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| numberOfDays | integer , optional |
|
| interest | array[object] , optional |
Provides general interest information that applies to the account at a particular moment in time. |
| tax | object , optional |
See document "openFinance API Framework Data Dictionary", section "Tax" for more details. |
| rate | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| amount | object , optional |
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 |
| identification | string , optional |
|
| rate | array[object] , optional |
See document "openFinance API Framework Data Dictionary", section "Rate" for more details. |
| typeOther | string , optional |
|
| validityRange | object , optional |
See document "openFinance API Framework Data Dictionary", section "Amount Range" for more details. |
| toAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| fromAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| equalAmount | object , optional |
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 |
| fromToAmount | object , optional |
See document "openFinance API Framework Data Dictionary", section "From To Amount Range" for more details. |
| toAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| fromAmount | object , required |
See document "openFinance API Framework Data Dictionary", section "Boundary Amount" for more details. |
| included | boolean , required |
|
| boundaryAmount | 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 |
| notEqualAmount | object , optional |
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 |
| typePercentage | string , optional |
See document "openFinance API Framework Data Dictionary", section "Other ISO-related basic Types" for more details. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%. |
| reason | string , optional |
specifies the reason for the interest |
| typeCode | string , optional |
INDY for Intraday interest and OVRN Overnight for overnight interest as the only permitted codes. Allowed values: INDY, OVRN |
| toDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| fromDateTime | string , optional |
A date and time in ISO 8601 format. Format: date-time |
| typeProprietary | string , optional |
|
| pageNumber | integer , optional |
Page Number. |
| toDateTime | string , optional |
Date and time at which the period ends Remark: The value 24:00:00 should be used for expressing that only the date is relevant. Format: date-time |
| fromDateTime | string , optional |
Date and time at which the period starts. Remark: The value 00:00:00 should be used for expressing that only the date is relevant Format: date-time |
| identification | string , required |
Unique identification, as assigned by the account servicer, to unambiguously identify the account statement. |
| relatedAccount | object , optional |
Identifies the parent account of the account, for which the statement has been issued. |
| pan | string , optional |
Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements. |
| bban | string , optional |
BBAN of the account. This data elements is used for payment accounts which have no IBAN. |
| iban | string , optional |
International Bank Account Number. |
| name | string , optional |
Name 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 |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| postaladdress | object , optional |
Postal Address of the party. |
| 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. |
| proxy | object , optional |
A proxy that identifies the account, such as a phone number or email. |
| typeCode | string , optional |
Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID |
| identification | string , required |
|
| typeProprietary | string , optional |
|
| msisdn | string , optional |
An alias to access a payment account via a registered mobile phone number. |
| currency | string , optional |
ISO 4217 Alpha 3 currency code |
| servicer | object , optional |
Identification of a financial institution. |
| name | string , optional |
Name of the financial institution |
| bicfi | string , optional |
Business Identifier Code (BIC) of a financial institution. |
| other | 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 a financial insitution. |
| schemeNameCode | string , optional |
An entry provided by an external ISO code list |
| schemeNameProprietary | string , optional |
A scheme name defined in a proprietary way. |
| postalAddress | object , optional |
Postal Address of the financial institution. |
| 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. |
| clearingSystemMemberId | object , optional |
Information used to identify a member within a clearing system. |
| memberId | string , optional |
Identification of a member of a clearing system. |
| clearingSystemIdentificationCode | string , optional |
Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK |
| clearingSystemIdentificationProprietary | string , optional |
Identification code for a clearing system, that has not yet been identified in the list of clearing systems. |
| typeCode | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. 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 |
| maskedPan | string , optional |
Primary Account Number (PAN) of a card in a masked form. |
| typeProprietary | string , optional |
Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP. |
| creationDateTime | string , optional |
Date and time at which the statement was created. Format: date-time |
| lastPageIndicator | boolean , optional |
Indicates the last page. |
| transactionSummary | object , optional |
Provides transction summary Information |
| totalEntries | object , optional |
The total number and sum of credit and debit entries. |
| sum | number , optional |
The sum of total individual entries. Format: double |
| totalNetEntry | object , optional |
The debit or credit amount of the netted amounts of all credit and debit entries. |
| amount | object , required |
Amount of the netted amount of all debit and credit entries. |
| 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 |
| creditDebitIndicator | string , required |
Indicated whether the amount is a debit or credit amount. Allowed values: CRDT, DBIT |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| totalDebitEntries | object , optional |
The total number and sum of debit entries |
| sum | number , optional |
The sum of total debit entries. Format: double |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| totalCreditEntries | object , optional |
The total number and sum of credit entries |
| sum | number , optional |
The sum of total credit entries. Format: double |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| totalEntriesPerBankTransactionCode | array[object] , optional |
The total number and sum of entries per bank transaction code |
| sum | number , optional |
The sum of total individual entries. Format: double |
| date | string , optional |
Date of the transaction summary Format: date |
| dateTime | string , optional |
Date and time of the transaction summary Format: date-time |
| availability | array[object] , optional |
Indicated when the booked amount of money will be available |
| amount | 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 |
| actualDate | string , optional |
A date in ISO 8601 format (YYYY-MM-DD). Format: date |
| numberOfDays | integer , optional |
|
| debitEntries | object , optional |
Number of individual debit entries for the bank transaction code |
| sum | number , optional |
The sum of the debit entries. Format: double |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| creditEntries | object , optional |
Number of individual credit entries for the bank transaction code |
| sum | number , optional |
The sum of credit entries. Format: double |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| totalNetEntry | object , optional |
The debit or credit amount of the netted amounts of all credit and debit entries. |
| amount | object , required |
Amount of the netted amount of all debit and credit entries. |
| 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 |
| creditDebitIndicator | string , required |
Indicated whether the amount is a debit or credit amount. Allowed values: CRDT, DBIT |
| numberOfEntries | string , optional |
Only numeric text is permitted. |
| forecastIndicator | boolean , optional |
Indicated whether the bank transaction code is related to booked or forcast items. |
| bankTransactionCode | string , required |
Set of elements used to fully identify the type of transaction resulting in an entry. |
| legalSequenceNumber | integer , optional |
Legal sequential number of the statement, as assigned by the account servicer. It is increased incrementally for each statement sent. |
| electronicSequenceNumber | integer , optional |
Sequential number of the statement, as assigned by the account servicer. Usage: The sequential number is increased incrementally for each statement sent electronically. |
| pageNumber | integer , optional |
Page number. |
| creationDateTime | string , required |
Date and time at which the message was created. Format: date-time |
| messageRecipient | object , optional |
Party authorised by the account owner to receive information about movements on the account. |
| 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. |
| lastPageIndicator | boolean , optional |
Indicates the last page. |
| 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 |
|