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 transactions
/v2/savings/{account-id}/transactions
Reads account transaction data from a given savings account addressed by "account-id". See "Implementation Guidelines for Extended Services ", section "4.3.4 Read Transaction List".
Path parameters
| Parameter | Type | Description |
|---|---|---|
| account-id | string , required |
This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent. Example: Allowed length: max: 70 |
Query parameters
| Parameter | Type | Description |
|---|---|---|
| dateFrom | string , optional |
Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information". For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. Example: Format: date |
| dateTo | string , optional |
End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP. Example: Format: date |
| entryReferenceFrom | string , optional |
This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider. Example: Allowed length: max: 35 |
| bookingStatus | string , required |
Permitted codes are * "booked", * "pending", * "both", * "information" and * "all" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend. If supported, "both" means to request transaction reports of transaction of bookingStatus either "pending" or "booked". To support the "information" feature is optional for the ASPSP. Currently the booking status "information" only covers standing orders. Error code if not supported. To support the "all" feature is optional for the ASPSP, Error code if not supported. If supported, "all" means to request transaction reports of transaction of any bookingStatus ("pending", "booked" or "information"). Allowed values: information, booked, pending, both, all Example: |
| deltaList | boolean , optional |
This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider Example: |
| pageSize | integer , optional |
This query parameter defines the transaction entries per call to be retrieved for extended services. If not supported, then the call is rejected. If supported by the ASPSP and if the value is higher than maxPageSize as defined by the ASPSP in its documentation, then the call is rejected. Example: |
Header parameters
| Header | Type | Description |
|---|---|---|
| Digest | string , optional |
Integrity hash of the request body in the form Example: |
| x-jws-signature | string , optional |
Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed. |
| X-Request-ID | string , required |
Unique ID of the request, set by the initiating party and echoed back in the response. Example: Format: uuid |
| API-Contract-ID | string , optional |
Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service. Example: Format: uuid |
| PSU-IP-Address | string , optional |
IP address of the PSU's device as forwarded by the TPP. If unavailable, use the IP address the TPP used for this request. Example: Format: ipv4 |
| Consent-ID | string , optional |
Identifier of the consent that authorises this access, as returned when the consent was created. Example: Allowed length: max: 70 |
Responses
Select a status code to see the structure and an example of the response.
| Field | Type | Description |
|---|---|---|
| account | object , required |
Identifier of the addressed 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. |
| balances | array[object] , optional |
A list of balances regarding this account, which might be restricted to the current balance. |
| balanceType | string , required |
Type of balance. Allowed values: closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced |
| balanceAmount | object , required |
An amount with its currency. |
| amount | string , required |
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| referenceDate | string , optional |
indicates the date of the balance Format: date |
| lastChangeDateTime | string , optional |
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. Format: date-time |
| creditLimitIncluded | boolean , optional |
A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable. |
| lastCommittedTransaction | string , optional |
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known. |
| transactions | object , optional |
JSON based account report. This account report contains transactions resulting from the query parameters. |
| booked | array[object] , optional |
Shall be contained if bookingStatus parameter is set to "booked", "both" or "all". |
| debtor | object , optional |
Name and potentially an identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| 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. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date. Format: date |
| references | object , optional |
Might contain the payment identification attributes endToEndId as well as the new UETR field. In addition it is inlduing accountServicerReference, mandateId, checkId (all level 1 fields in V1.3.x). |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| bookingDate | string , optional |
The Date when an entry is posted to an account on the ASPSPs books. Format: date |
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| entryDetails | array[object] , optional |
Might be used by the ASPSP to transport details about transactions within a batch. |
| debtor | object , optional |
Name and potentially identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| references | object , optional |
might contain the endToEndId as well as the new UETR field |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| 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. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction as billed to the account. |
| 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 |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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. |
| remittanceInformationUnstructured | array[string] , optional |
|
| amountDetails | object , optional |
Additional information to the transaction 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. |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| transactionId | string , optional |
Can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request. Remark: ASPSPs should ensure that transactionID, if provided, is unique relative to the account that PSU is accessing, in order to ensure the quality of the data provided to the API Client. |
| batchIndicator | boolean , optional |
If this indicator equals "true", then the related entry is a batch entry. |
| entryReference | string , optional |
Is the identification of the transaction as used e.g. for reference for delta function on application level. The same identification as for example used within camt.05x messages. |
| ultimateDebtor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| cardTransaction | object , optional |
Card transaction details in case of an underlying card transaction. |
| 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 |
| creditorAccount | object , optional |
Account of the payee. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
Only name and identification is supported for now for this party. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction or batch as billed to the account. |
| 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 |
| bankTransactionCode | string , optional |
Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO20022. For standing order reports the following codes are applicable: "PMNT-ICDT-STDO" for credit transfers, "PMNT-IRCT-STDO" for instant credit transfers "PMNT-ICDT-XBST" for cross-border credit transfers "PMNT-IRCT-XBST" for cross-border real time credit transfers and "PMNT-MCOP-OTHR" for specific standing orders which have a dynamical amount to move left funds e.g. on month end to a saving account |
| localInstrumentCode | string , optional |
User community specific instrument as a code provided by ISO20022. 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 |
| balanceAfterTransaction | object , optional |
This is the balance after this transaction. Recommended balance type is interimBooked. |
| balanceType | string , required |
Type of balance. Allowed values: closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced |
| balanceAmount | object , required |
An amount with its currency. |
| amount | string , required |
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| referenceDate | string , optional |
indicates the date of the balance Format: date |
| lastChangeDateTime | string , optional |
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. Format: date-time |
| creditLimitIncluded | boolean , optional |
A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable. |
| lastCommittedTransaction | string , optional |
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known. |
| interbankSettlementDate | string , optional |
Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. Format: date |
| batchNumberOfTransactions | integer , optional |
Shall be used if and only if the batchIndicator is contained and equals "true". |
| localInstrumentProprietary | string , optional |
User community specific instrument as a proprietary attribute. |
| bankTransactionCodeProprietary | string , optional |
proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports. Renaming of the attribute to adapt to statements. |
| additionalInformationStructured | object , optional |
Is used if and only if the bookingStatus entry equals "information". Every active standing order related to the dedicated payment account result into one entry. Each received RTP result into one entry. |
| rtpDetails | object , optional |
Details of underlying incoming RTPs |
| originatorPspId | object , optional |
Originator payment service provider in case of indirect participation regarding a related API Access Scheme or bilateral contract |
| 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. |
| creationDateTime | string , optional |
creationDateTime of the originator Format: date-time |
| paymentConditions | object , optional |
Conditions for the execution of the payment. |
| earlyPaymentAllowed | boolean , optional |
Indicates if the debtor is allowed to pay before the requested execution date. |
| amountModificationAllowed | boolean , optional |
Indicates if the debtor is allowed to pay a different amount then the requested amount. |
| requestedExpiryDateTime | string , required |
Date and Time at which this request expires. Format: date-time |
| standingOrderDetails | object , optional |
Details of underlying standing orders. |
| endDate | string , optional |
The last applicable day of execution If not given, it is an infinite standing order. Format: date |
| frequency | string , required |
The frequency of the recurring payment resulting from this standing order. Allowed values: Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual, MonthlyVariable |
| paymentId | string , required |
Only included for AIS. Resource Identifier of the standing order resource. Format: uuid |
| startDate | string , optional |
The first applicable day of execution starting from this date the first payment was/will be executed. Format: date |
| displayName | string , optional |
Name of the standing order defined by the PSU and displayed within the online channels. |
| endDateTime | string , optional |
The last applicable day and time of requested execution. This attribute is only applicable to instant payments. If none of the attributes is given, it is an infinite standing order. The ASPSP might restrict the implementation to endDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| limitAmount | object , optional |
limitAmount Amount limit for fund skimming, e.g. skim all funds above this limit to savings account, i.e. typically a specific periodic payments with fixed remaining amount rather than fixed transaction amount. Amount may be zero as well as below zero, i.e. negative. Constraints: transactionAmount needs to be zero and bankTransactionCode needs to specify "PMNT-MCOP-OTHR" for fund skimming. |
| 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 |
| executionRule | string , optional |
"following" or "preceding" supported as values. This data attribute defines the behavior when a transaction date resulting from a standing order falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. Allowed values: Preceding, Following |
| multiplicator | number , optional |
This is multiplying the given frequency resulting the exact frequency, e.g. Frequency=weekly and multiplicator=3 means every 3 weeks. Remark: This attribute is rarely supported in the market. |
| startDateTime | string , optional |
The first applicable day and time of execution starting from this timestamp. This attribute is only applicable to instant payments. Seconds and milli seconds might be ignored by the ASPSP. The ASPSP might restrict the implementation to startDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| dayOfExecution | string , optional |
"31" is ultimo. The format is following the regular expression \d{1,2}. Example: The first day is addressed by "1". The date is referring to the time zone of the ASPSP. |
| paymentProduct | string , required |
Only included for AIS. This yields the payment product of the standing order resource. |
| withinAMonthFlag | boolean , optional |
This element is only used in case of frequency equals "Monthly". If this element equals false it has no effect. If this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule. Example: executionRule equals "preceding", dayOfExecution equals "02" and the second of a month is a Sunday. In this case, the transaction date would be on the last day of the month before. This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month. Remark: This attribute is rarely supported in the market. |
| monthsOfExecution | array[string] , optional |
The format is following the regular expression \d{1,2}. The array is restricted to 11 entries. The values contained In the array entries shall all be different and the maximum value of one entry is 12. This attribute is contained if and only if the frequency equals "MonthlyVariable". Example: An execution on January, April and October each year is addressed by ["1". "4", "10"]. |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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 |
Might be used by the ASPSP to transport additional transaction related information to the PSU |
| remittanceInformationUnstructured | array[string] , optional |
|
| additionalTransactionInformationStructured | object , optional |
Data about the transactional process of submission, authorisation and/or cancellation of the underlying payment. |
| transactionStatus | string , required |
ISO 20022 transaction status code. Allowed values: ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART, PRES, RVCM, RVNC, RCVC |
| transactionCreated | object , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionCancelled | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionAuthorised | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| _links | object , optional |
The following links could be used here: "transactionDetails" for retrieving details of a transaction. |
| 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 |
|
| pending | array[object] , optional |
Not contained if the bookingStatus parameter is set to "booked" or "information". |
| debtor | object , optional |
Name and potentially an identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| 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. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date. Format: date |
| references | object , optional |
Might contain the payment identification attributes endToEndId as well as the new UETR field. In addition it is inlduing accountServicerReference, mandateId, checkId (all level 1 fields in V1.3.x). |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| bookingDate | string , optional |
The Date when an entry is posted to an account on the ASPSPs books. Format: date |
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| entryDetails | array[object] , optional |
Might be used by the ASPSP to transport details about transactions within a batch. |
| debtor | object , optional |
Name and potentially identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| references | object , optional |
might contain the endToEndId as well as the new UETR field |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| 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. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction as billed to the account. |
| 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 |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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. |
| remittanceInformationUnstructured | array[string] , optional |
|
| amountDetails | object , optional |
Additional information to the transaction 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. |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| transactionId | string , optional |
Can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request. Remark: ASPSPs should ensure that transactionID, if provided, is unique relative to the account that PSU is accessing, in order to ensure the quality of the data provided to the API Client. |
| batchIndicator | boolean , optional |
If this indicator equals "true", then the related entry is a batch entry. |
| entryReference | string , optional |
Is the identification of the transaction as used e.g. for reference for delta function on application level. The same identification as for example used within camt.05x messages. |
| ultimateDebtor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| cardTransaction | object , optional |
Card transaction details in case of an underlying card transaction. |
| 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 |
| creditorAccount | object , optional |
Account of the payee. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
Only name and identification is supported for now for this party. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction or batch as billed to the account. |
| 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 |
| bankTransactionCode | string , optional |
Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO20022. For standing order reports the following codes are applicable: "PMNT-ICDT-STDO" for credit transfers, "PMNT-IRCT-STDO" for instant credit transfers "PMNT-ICDT-XBST" for cross-border credit transfers "PMNT-IRCT-XBST" for cross-border real time credit transfers and "PMNT-MCOP-OTHR" for specific standing orders which have a dynamical amount to move left funds e.g. on month end to a saving account |
| localInstrumentCode | string , optional |
User community specific instrument as a code provided by ISO20022. 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 |
| balanceAfterTransaction | object , optional |
This is the balance after this transaction. Recommended balance type is interimBooked. |
| balanceType | string , required |
Type of balance. Allowed values: closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced |
| balanceAmount | object , required |
An amount with its currency. |
| amount | string , required |
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| referenceDate | string , optional |
indicates the date of the balance Format: date |
| lastChangeDateTime | string , optional |
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. Format: date-time |
| creditLimitIncluded | boolean , optional |
A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable. |
| lastCommittedTransaction | string , optional |
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known. |
| interbankSettlementDate | string , optional |
Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. Format: date |
| batchNumberOfTransactions | integer , optional |
Shall be used if and only if the batchIndicator is contained and equals "true". |
| localInstrumentProprietary | string , optional |
User community specific instrument as a proprietary attribute. |
| bankTransactionCodeProprietary | string , optional |
proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports. Renaming of the attribute to adapt to statements. |
| additionalInformationStructured | object , optional |
Is used if and only if the bookingStatus entry equals "information". Every active standing order related to the dedicated payment account result into one entry. Each received RTP result into one entry. |
| rtpDetails | object , optional |
Details of underlying incoming RTPs |
| originatorPspId | object , optional |
Originator payment service provider in case of indirect participation regarding a related API Access Scheme or bilateral contract |
| 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. |
| creationDateTime | string , optional |
creationDateTime of the originator Format: date-time |
| paymentConditions | object , optional |
Conditions for the execution of the payment. |
| earlyPaymentAllowed | boolean , optional |
Indicates if the debtor is allowed to pay before the requested execution date. |
| amountModificationAllowed | boolean , optional |
Indicates if the debtor is allowed to pay a different amount then the requested amount. |
| requestedExpiryDateTime | string , required |
Date and Time at which this request expires. Format: date-time |
| standingOrderDetails | object , optional |
Details of underlying standing orders. |
| endDate | string , optional |
The last applicable day of execution If not given, it is an infinite standing order. Format: date |
| frequency | string , required |
The frequency of the recurring payment resulting from this standing order. Allowed values: Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual, MonthlyVariable |
| paymentId | string , required |
Only included for AIS. Resource Identifier of the standing order resource. Format: uuid |
| startDate | string , optional |
The first applicable day of execution starting from this date the first payment was/will be executed. Format: date |
| displayName | string , optional |
Name of the standing order defined by the PSU and displayed within the online channels. |
| endDateTime | string , optional |
The last applicable day and time of requested execution. This attribute is only applicable to instant payments. If none of the attributes is given, it is an infinite standing order. The ASPSP might restrict the implementation to endDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| limitAmount | object , optional |
limitAmount Amount limit for fund skimming, e.g. skim all funds above this limit to savings account, i.e. typically a specific periodic payments with fixed remaining amount rather than fixed transaction amount. Amount may be zero as well as below zero, i.e. negative. Constraints: transactionAmount needs to be zero and bankTransactionCode needs to specify "PMNT-MCOP-OTHR" for fund skimming. |
| 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 |
| executionRule | string , optional |
"following" or "preceding" supported as values. This data attribute defines the behavior when a transaction date resulting from a standing order falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. Allowed values: Preceding, Following |
| multiplicator | number , optional |
This is multiplying the given frequency resulting the exact frequency, e.g. Frequency=weekly and multiplicator=3 means every 3 weeks. Remark: This attribute is rarely supported in the market. |
| startDateTime | string , optional |
The first applicable day and time of execution starting from this timestamp. This attribute is only applicable to instant payments. Seconds and milli seconds might be ignored by the ASPSP. The ASPSP might restrict the implementation to startDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| dayOfExecution | string , optional |
"31" is ultimo. The format is following the regular expression \d{1,2}. Example: The first day is addressed by "1". The date is referring to the time zone of the ASPSP. |
| paymentProduct | string , required |
Only included for AIS. This yields the payment product of the standing order resource. |
| withinAMonthFlag | boolean , optional |
This element is only used in case of frequency equals "Monthly". If this element equals false it has no effect. If this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule. Example: executionRule equals "preceding", dayOfExecution equals "02" and the second of a month is a Sunday. In this case, the transaction date would be on the last day of the month before. This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month. Remark: This attribute is rarely supported in the market. |
| monthsOfExecution | array[string] , optional |
The format is following the regular expression \d{1,2}. The array is restricted to 11 entries. The values contained In the array entries shall all be different and the maximum value of one entry is 12. This attribute is contained if and only if the frequency equals "MonthlyVariable". Example: An execution on January, April and October each year is addressed by ["1". "4", "10"]. |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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 |
Might be used by the ASPSP to transport additional transaction related information to the PSU |
| remittanceInformationUnstructured | array[string] , optional |
|
| additionalTransactionInformationStructured | object , optional |
Data about the transactional process of submission, authorisation and/or cancellation of the underlying payment. |
| transactionStatus | string , required |
ISO 20022 transaction status code. Allowed values: ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART, PRES, RVCM, RVNC, RCVC |
| transactionCreated | object , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionCancelled | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionAuthorised | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| _links | object , optional |
The following links could be used here: "transactionDetails" for retrieving details of a transaction. |
| 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 |
|
| information | array[object] , optional |
Only contained if the bookingStatus is set to "information" or "all" and if supported by ASPSP. |
| debtor | object , optional |
Name and potentially an identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| 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. Usage: If entry status is pending and value date is present, then the value date refers to an expected/requested value date. Format: date |
| references | object , optional |
Might contain the payment identification attributes endToEndId as well as the new UETR field. In addition it is inlduing accountServicerReference, mandateId, checkId (all level 1 fields in V1.3.x). |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| bookingDate | string , optional |
The Date when an entry is posted to an account on the ASPSPs books. Format: date |
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| entryDetails | array[object] , optional |
Might be used by the ASPSP to transport details about transactions within a batch. |
| debtor | object , optional |
Name and potentially identification of the debtor if a "Credited" 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 |
Name and potentially an identification of the creditor if a "Debited" 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: |
| references | object , optional |
might contain the endToEndId as well as the new UETR field |
| 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. |
| endToEndId | string , optional |
|
| checkNumber | string , optional |
|
| instructionId | string , optional |
Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. |
| accountServicerReference | string , optional |
|
| debtorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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 |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| 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. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction as billed to the account. |
| 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 |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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. |
| remittanceInformationUnstructured | array[string] , optional |
|
| amountDetails | object , optional |
Additional information to the transaction 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. |
| creditorAgent | object , optional |
Proprietary identifications might be provided under financialInstitutionId/other |
| 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. |
| 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. |
| transactionId | string , optional |
Can be used as access-ID in the API, where more details on an transaction is offered. If this data attribute is provided this shows that the AIS can get access on more details about this transaction using the GET Transaction Details Request. Remark: ASPSPs should ensure that transactionID, if provided, is unique relative to the account that PSU is accessing, in order to ensure the quality of the data provided to the API Client. |
| batchIndicator | boolean , optional |
If this indicator equals "true", then the related entry is a batch entry. |
| entryReference | string , optional |
Is the identification of the transaction as used e.g. for reference for delta function on application level. The same identification as for example used within camt.05x messages. |
| ultimateDebtor | object , optional |
A party involved in the transaction. |
| name | string , optional |
Name of the party. |
| 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. |
| cardTransaction | object , optional |
Card transaction details in case of an underlying card transaction. |
| 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 |
| creditorAccount | object , optional |
Account of the payee. |
| 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. |
| currencyExchange | array[object] , optional |
Exchange rate details applied to the amount. |
| 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. |
| ultimateCreditor | object , optional |
Only name and identification is supported for now for this party. |
| name | string , optional |
Name of the party. |
| 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. |
| transactionAmount | object , required |
The amount of the transaction or batch as billed to the account. |
| 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 |
| bankTransactionCode | string , optional |
Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO20022. For standing order reports the following codes are applicable: "PMNT-ICDT-STDO" for credit transfers, "PMNT-IRCT-STDO" for instant credit transfers "PMNT-ICDT-XBST" for cross-border credit transfers "PMNT-IRCT-XBST" for cross-border real time credit transfers and "PMNT-MCOP-OTHR" for specific standing orders which have a dynamical amount to move left funds e.g. on month end to a saving account |
| localInstrumentCode | string , optional |
User community specific instrument as a code provided by ISO20022. 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 |
| balanceAfterTransaction | object , optional |
This is the balance after this transaction. Recommended balance type is interimBooked. |
| balanceType | string , required |
Type of balance. Allowed values: closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced |
| balanceAmount | object , required |
An amount with its currency. |
| amount | string , required |
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | string , required |
ISO 4217 Alpha 3 currency code |
| referenceDate | string , optional |
indicates the date of the balance Format: date |
| lastChangeDateTime | string , optional |
This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked. Format: date-time |
| creditLimitIncluded | boolean , optional |
A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable. |
| lastCommittedTransaction | string , optional |
entryReference of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known. |
| interbankSettlementDate | string , optional |
Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. Format: date |
| batchNumberOfTransactions | integer , optional |
Shall be used if and only if the batchIndicator is contained and equals "true". |
| localInstrumentProprietary | string , optional |
User community specific instrument as a proprietary attribute. |
| bankTransactionCodeProprietary | string , optional |
proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports. Renaming of the attribute to adapt to statements. |
| additionalInformationStructured | object , optional |
Is used if and only if the bookingStatus entry equals "information". Every active standing order related to the dedicated payment account result into one entry. Each received RTP result into one entry. |
| rtpDetails | object , optional |
Details of underlying incoming RTPs |
| originatorPspId | object , optional |
Originator payment service provider in case of indirect participation regarding a related API Access Scheme or bilateral contract |
| 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. |
| creationDateTime | string , optional |
creationDateTime of the originator Format: date-time |
| paymentConditions | object , optional |
Conditions for the execution of the payment. |
| earlyPaymentAllowed | boolean , optional |
Indicates if the debtor is allowed to pay before the requested execution date. |
| amountModificationAllowed | boolean , optional |
Indicates if the debtor is allowed to pay a different amount then the requested amount. |
| requestedExpiryDateTime | string , required |
Date and Time at which this request expires. Format: date-time |
| standingOrderDetails | object , optional |
Details of underlying standing orders. |
| endDate | string , optional |
The last applicable day of execution If not given, it is an infinite standing order. Format: date |
| frequency | string , required |
The frequency of the recurring payment resulting from this standing order. Allowed values: Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual, MonthlyVariable |
| paymentId | string , required |
Only included for AIS. Resource Identifier of the standing order resource. Format: uuid |
| startDate | string , optional |
The first applicable day of execution starting from this date the first payment was/will be executed. Format: date |
| displayName | string , optional |
Name of the standing order defined by the PSU and displayed within the online channels. |
| endDateTime | string , optional |
The last applicable day and time of requested execution. This attribute is only applicable to instant payments. If none of the attributes is given, it is an infinite standing order. The ASPSP might restrict the implementation to endDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| limitAmount | object , optional |
limitAmount Amount limit for fund skimming, e.g. skim all funds above this limit to savings account, i.e. typically a specific periodic payments with fixed remaining amount rather than fixed transaction amount. Amount may be zero as well as below zero, i.e. negative. Constraints: transactionAmount needs to be zero and bankTransactionCode needs to specify "PMNT-MCOP-OTHR" for fund skimming. |
| 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 |
| executionRule | string , optional |
"following" or "preceding" supported as values. This data attribute defines the behavior when a transaction date resulting from a standing order falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. Allowed values: Preceding, Following |
| multiplicator | number , optional |
This is multiplying the given frequency resulting the exact frequency, e.g. Frequency=weekly and multiplicator=3 means every 3 weeks. Remark: This attribute is rarely supported in the market. |
| startDateTime | string , optional |
The first applicable day and time of execution starting from this timestamp. This attribute is only applicable to instant payments. Seconds and milli seconds might be ignored by the ASPSP. The ASPSP might restrict the implementation to startDate. This restriction will be part of the ASPSP documentation. Format: date-time |
| dayOfExecution | string , optional |
"31" is ultimo. The format is following the regular expression \d{1,2}. Example: The first day is addressed by "1". The date is referring to the time zone of the ASPSP. |
| paymentProduct | string , required |
Only included for AIS. This yields the payment product of the standing order resource. |
| withinAMonthFlag | boolean , optional |
This element is only used in case of frequency equals "Monthly". If this element equals false it has no effect. If this element equals true, then the execution rule is overruled if the day of execution would fall into a different month using the execution rule. Example: executionRule equals "preceding", dayOfExecution equals "02" and the second of a month is a Sunday. In this case, the transaction date would be on the last day of the month before. This would be overruled if withinAMonthFlag equals true and the payment is processed on Monday the third of the Month. Remark: This attribute is rarely supported in the market. |
| monthsOfExecution | array[string] , optional |
The format is following the regular expression \d{1,2}. The array is restricted to 11 entries. The values contained In the array entries shall all be different and the maximum value of one entry is 12. This attribute is contained if and only if the frequency equals "MonthlyVariable". Example: An execution on January, April and October each year is addressed by ["1". "4", "10"]. |
| remittanceInformationStructured | array[object] , optional |
Remittance information for the transaction. |
| referredDocumentInformation | 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 |
Might be used by the ASPSP to transport additional transaction related information to the PSU |
| remittanceInformationUnstructured | array[string] , optional |
|
| additionalTransactionInformationStructured | object , optional |
Data about the transactional process of submission, authorisation and/or cancellation of the underlying payment. |
| transactionStatus | string , required |
ISO 20022 transaction status code. Allowed values: ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART, PRES, RVCM, RVNC, RCVC |
| transactionCreated | object , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionCancelled | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| transactionAuthorised | array[object] , optional |
Timestamp and PSU details of a processing step. |
| user | string , required |
|
| dateTime | string , required |
A date and time in ISO 8601 format. Format: date-time |
| _links | object , optional |
The following links could be used here: "transactionDetails" for retrieving details of a transaction. |
| 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 |
|
| _links | object , required |
The following links might be used within this context: * account (mandatoryin the context of cash accounts) * savingsAccount (mandatory in the context of savings accounts) * loanAccount (mandatory in the context of loan accounts) * first (optional) * next (optional) * previous (optional) * last (optional) |
| 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 |
|
| _links | object , optional |
A list of hyperlinks to be recognised by the TPP. Type of links admitted in this response: "download": a link to a resource, where the transaction list might be downloaded from in case where transaction lists have a huge size. Remark: This feature shall only be used where camt-data is requested which has a huge size. |
| download | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). Allowed values: FORMAT_ERROR, PARAMETER_NOT_CONSISTENT, PARAMETER_NOT_SUPPORTED, SERVICE_INVALID, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED, RESOURCE_BLOCKED, TIMESTAMP_INVALID, PERIOD_INVALID, SCA_METHOD_UNKNOWN, SCA_INVALID, CONSENT_TYPE_NOT_SUPPORTED, SESSIONS_NOT_SUPPORTED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). Allowed values: CERTIFICATE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, ROLE_INVALID, PSU_CREDENTIALS_INVALID, CORPORATE_ID_INVALID, CONSENT_INVALID, CONSENT_EXPIRED, TOKEN_UNKNOWN, TOKEN_INVALID, TOKEN_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). Allowed values: SERVICE_BLOCKED, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|
| Field | Type | Description |
|---|---|---|
| apiClientMessages | array[object] , optional |
Errors and warnings describing why the request failed. See Errors for the message format. |
| code | string , required |
Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). Allowed values: SERVICE_INVALID Example: |
| path | string , optional |
|
| text | string , optional |
Example: Allowed length: max: 500 |
| category | string , required |
Only "ERROR" or "WARNING" permitted |
| _links | object , optional |
Hyperlinks to related resources. |
| last | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| next | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| self | object , optional |
The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation. |
| href | string , required |
|
| first | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| orders | object , optional |
A link to the resource providing the list of orders of one securitiesAccount. |
| href | string , required |
|
| status | object , optional |
A link to retrieve the status of the transaction resource. |
| href | string , required |
|
| account | object , optional |
A link to the resource providing the details of one account |
| href | string , required |
|
| balances | object , optional |
A link to the resource providing the balance of a dedicated account. |
| href | string , required |
|
| download | object , optional |
Download link for huge AIS data packages. |
| href | string , required |
|
| previous | object , optional |
Navigation link for paginated account reports. |
| href | string , required |
|
| scaOAuth | object , optional |
The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414]. |
| href | string , required |
|
| ibanCheck | object , optional |
A link to the endpoint offering the addressed iban check result. |
| href | string , required |
|
| positions | object , optional |
A link to the resource providing the list of positions of one securitiesAccount. |
| href | string , required |
|
| scaStatus | object , optional |
A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource. |
| href | string , required |
|
| cardAccount | object , optional |
A link to the resource providing the details of one card account. |
| href | string , required |
|
| loanAccount | object , optional |
A link to the resource providing the details of a loan account. |
| href | string , required |
|
| onboardings | object , optional |
A link to commercially onboard to the related API, see openFinance, Admin Services for more details. |
| href | string , required |
|
| scaRedirect | object , optional |
A link to an ASPSP site where SCA is performed within the Redirect SCA approach. |
| href | string , required |
|
| confirmation | object , optional |
"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server. |
| href | string , required |
|
| orderDetails | object , optional |
A link to the resource providing details of one specific order. |
| href | string , required |
|
| subscription | object , optional |
A link to the resource providing the details of a subscription for Push AIS Services. |
| href | string , required |
|
| transactions | object , optional |
A link to the resource providing the transaction history of a dedicated account. |
| href | string , required |
|
| aspspContacts | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| relatedOrders | array[object] , optional |
An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order). |
| href | string , required |
|
| aspspDowntimes | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| readConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| savingsAccount | object , optional |
A link to the resource providing the details of a savings account. |
| href | string , required |
|
| aspspParameters | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| transactionfees | object , optional |
The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource. |
| href | string , required |
|
| cardTransactions | object , optional |
A link to the resource providing the transaction history of a dedicated card account. |
| href | string , required |
|
| confirmConditions | object , optional |
A hyperlink object containing the target URL. |
| href | string , required |
|
| confirmInitiation | object , optional |
link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution. |
| href | string , required |
|
| paymentInitiation | object , optional |
A link to an initiation related to a payment resource. |
| href | string , required |
|
| securitiesAccount | object , optional |
A link to the resource providing the details of one securitiesAccount. |
| href | string , required |
|
| entryStatusRevoked | array[object] , optional |
Links to entry endpoints where the entry status is revoked. |
| href | string , required |
|
| startAuthorisation | object , optional |
A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start. |
| href | string , required |
|
| transactionDetails | object , optional |
A link to the resource providing details of a dedicated transaction. |
| href | string , required |
|
| relatedTransactions | array[object] , optional |
An array of links to request securities transaction details of transactions that resulted from this order. |
| href | string , required |
|
| authoriseTransaction | object , optional |
The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach. |
| href | string , required |
|
| updateProprietaryData | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the proprietary data. |
| href | string , required |
|
| updatePsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| updatePsuIdentification | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet. |
| href | string , required |
|
| creditorNameConfirmation | object , optional |
A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation. |
| href | string , required |
|
| selectAuthenticationMethod | object , optional |
This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods. |
| href | string , required |
|
| updateEncryptedPsuAuthentication | object , optional |
The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet. |
| href | string , required |
|
| startAuthorisationWithProprietaryData | object , optional |
A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink. |
| href | string , required |
|
| updateResourceByDebtorAccountResource | object , optional |
A link to a payment related resource which needs to be updated by an account, referenced by a resource identification. |
| href | string , required |
|
| startAuthorisationWithPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithPsuIdentification | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithTransactionAuthorisation | object , optional |
A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach. |
| href | string , required |
|
| startAuthorisationWithEncryptedPsuAuthentication | object , optional |
The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call. |
| href | string , required |
|
| startAuthorisationWithAuthenticationMethodSelection | object , optional |
This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call. |
| href | string , required |
|