--- title: "GET /accounts/{accountResourceId}/transactions" canonical: "https://openfinanceguide.com/en/stet/1.6.3/endpoints/aisp/accounts-transactions-get" edition: "STET PSD2 API 1.6.3.1" source: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.2-openapi.yaml" pdf: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf" section: "4.5" pdf_pages: "36" language: "en" normative: "The normative text is the English PDF and OpenAPI file published by STET. This Markdown reproduces it for reading; where they differ, the PDF prevails." license: "CC BY 3.0 FR (https://creativecommons.org/licenses/by/3.0/fr/), STET. Converted to Markdown by Open Finance Guide." parts: - "https://openfinanceguide.com/raw/stet/1.6.3/en/endpoints/aisp/accounts-transactions-get/operation.md" - "https://openfinanceguide.com/raw/stet/1.6.3/en/endpoints/aisp/accounts-transactions-get/schemas-1.md" - "https://openfinanceguide.com/raw/stet/1.6.3/en/endpoints/aisp/accounts-transactions-get/schemas-2.md" --- # GET /accounts/{accountResourceId}/transactions Retrieval of an account transaction set (AISP) Operation: `accountsTransactionsGet` · Tags: AISP · Scopes: `aisp` · Source: [§ 4.5 Retrieval of an account transaction set (AISP), PDF p. 36](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=36) ### Description This call returns transactions for an account for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query - on a given imputation date range - past a given incremental technical identification The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results. ### Prerequisites - The TPP was registered by the Registration Authority for the AISP role - The TPP and the PSU have a contract that was enrolled by the ASPSP - At this step, the ASPSP has delivered an OAUTH2 "Authorization Code" or "Resource Owner Password" access token to the TPP (cf. paragraph 3.4.2). - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its OAUTH2 "Authorization Code" or "Resource Owner Password" access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. paragraph 3.4.2) is any. - The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. - The TPP has previously retrieved the list of available accounts for the PSU ### Business flow The AISP requests the ASPSP on one of the PSU's accounts. It may specify some selection criteria. The ASPSP answers by a set of transactions that matches the query. - The result may be subject to pagination in order to avoid an excessive result set. - Case of no registered transaction on the account, this result will be an empty list. The default transaction set, in the absence of filter query parameter, has to be specified and documented by the implementation. The sort order of transaction might be specific to each ASPSP, due to each Information System constraints. ## Parameters - `Authorization`, in header, `string`, required — Access token to be passed as a header - `accountResourceId`, in path, `string`, required — Identification of account resource to fetch Constraints: pattern `^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$`. - `dateFrom`, in query, `string` — Inclusive minimal imputation date of the transactions. Transactions having an imputation date equal to this parameter are included within the result. - `dateTo`, in query, `string` — Exclusive maximal imputation date of the transactions. Transactions having an imputation date equal to this parameter are not included within the result. - `dateType`, in query, `string` — This parameter specifies the type of date on which [dateFrom] and [dateTo] apply. If not provided, the ASPSP will use its own default date type as specified in its implementation documentation. The implementation documentation must also specify which date types are supported. Values: `transactionDate`, `bookingDate`. - `entryReferenceFrom`, in query, `string` — Specifies the value on which the result has to be computed. Only the transaction having a technical identification greater than this value must be included within the result Constraints: maxLength 40. - `entryReferenceto`, in query, `string` — Specifies the value on which the result has to be computed. Only the transaction having a technical identification less than or equal to this value must be included within the result Constraints: maxLength 40. - `PSU-IP-Address`, in header, `string` — IP address used by the PSU's terminal when connecting to the TPP - `PSU-IP-Port`, in header, `string` — IP port used by the PSU's terminal when connecting to the TPP - `PSU-HTTP-Method`, in header, `string` — Http method for the most relevant PSU's terminal request to the TTP - `PSU-Date`, in header, `string` — Timestamp of the most relevant PSU's terminal request to the TTP - `PSU-GEO-Location`, in header, `string` — Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP - `PSU-User-Agent`, in header, `string` — "User-Agent" header field sent by the PSU terminal when connecting to the TPP - `PSU-Referer`, in header, `string` — "Referer" header field sent by the PSU terminal when connecting to the TPP. Notice that an initial typo in RFC 1945 specifies that "referer" (incorrect spelling) is to be used. The correct spelling "referrer" can be used but might not be understood. - `PSU-Accept`, in header, `string` — "Accept" header field sent by the PSU terminal when connecting to the TPP - `PSU-Accept-Charset`, in header, `string` — "Accept-Charset" header field sent by the PSU terminal when connecting to the TPP - `PSU-Accept-Encoding`, in header, `string` — "Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP - `PSU-Accept-Language`, in header, `string` — "Accept-Language" header field sent by the PSU terminal when connecting to the TPP - `PSU-Device-ID`, in header, `string` — UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of installation identification this ID need to be unaltered until removal from device. - `Digest`, in header, `string` — Digest of the body - `Signature`, in header, `string` — [http-signature of the request](https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) The keyId must specify the way to get the relevant qualified certificate. It is requested that this identifier is an URL aiming to provide the relevant Qualified Certificate. - `X-Request-ID`, in header, `string`, required — Correlation header to be set in a request and retrieved in the relevant response Constraints: maxLength 70. - `workspace`, in query, `string` — Workspace to be used for processing an AISP request. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. Constraints: maxLength 32. - `X-JWS-Signature`, in header, `string` — [JSON WEB signature of the request](https://www.openbankingeurope.eu/media/2095/obe-json-web-signature-profile-for-open-banking.pdf) ## Responses ### 200 Complete transactions response Body: [`HalTransactions`](#haltransactions) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 204 No content. Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 400 Invalid status value Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 401 Unauthorized, authentication failure. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 403 Forbidden, authentication successful but access to resource is not allowed. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 404 Not found, no request available. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 405 Method Not Allowed. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 406 Not Acceptable. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 408 Request Timeout. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 429 Too many requests. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response - `Warning`, `string` — Warning header. This header can be used by the server to inform the client of a deprecated entry-point through the value "299" value and a descriptive message. ### 500 Internal server error. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response ### 503 Service unavailable. Body: [`ErrorModel`](#errormodel) Headers: - `X-Request-ID`, `string` — Correlation header to be set in a request and retrieved in the relevant response ## Example Built from the specification: every documented header and field. ```bash curl -X GET 'https://api.aspsp.example/v1/accounts/{accountResourceId}/transactions' \ -H 'Authorization: Bearer {access_token}' \ -H 'PSU-IP-Address: 192.0.2.1' \ -H 'PSU-IP-Port: 443' \ -H 'PSU-HTTP-Method: GET' \ -H 'PSU-Date: Tue, 03 Oct 2022 10:15:30 GMT' \ -H 'PSU-GEO-Location: {PSU-GEO-Location}' \ -H 'PSU-User-Agent: {PSU-User-Agent}' \ -H 'PSU-Referer: {PSU-Referer}' \ -H 'PSU-Accept: {PSU-Accept}' \ -H 'PSU-Accept-Charset: {PSU-Accept-Charset}' \ -H 'PSU-Accept-Encoding: {PSU-Accept-Encoding}' \ -H 'PSU-Accept-Language: {PSU-Accept-Language}' \ -H 'PSU-Device-ID: {PSU-Device-ID}' \ -H 'Digest: SHA-256=X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=' \ -H 'Signature: keyId="...",algorithm="rsa-sha256",headers="(request-target) date digest",signature="..."' \ -H 'X-Request-ID: a1b2c3d4-e5f6-4a3b-8c2d-1e2f3a4b5c6d' \ -H 'X-JWS-Signature: {X-JWS-Signature}' ``` Response 200: ```json { "transactions": [ { "entryReference": "DHGF36DJ0", "transactionAmount": { "amount": 12.25, "currency": "EUR" }, "creditDebitIndicator": "DBIT", "status": "BOOK", "bookingDate": "2020-02-14T00:00+01:00", "remittanceInformation": { "unstructured": [ "Cheque n XXXXXXX" ] } }, { "entryReference": "DHGF36DJ1", "transactionAmount": { "amount": 66.38, "currency": "EUR" }, "creditDebitIndicator": "DBIT", "status": "BOOK", "bookingDate": "2020-02-14T00:00+01:00", "remittanceInformation": { "unstructured": [ "Prelevement ICS XXXXXXX" ] } } ], "_links": { "self": { "href": "/v1/accounts/Alias1/transactions" }, "parent-list": { "href": "/v1/accounts" }, "balances": { "href": "/v1/accounts/Alias1/balances" }, "overdrafts": { "href": "/v1/accounts/Alias1/overdrafts" }, "last": { "href": "/v1/accounts/Alias1/transactions?page=last" }, "next": { "href": "/v1/accounts/Alias1/transactions?page=next" } } } ``` ## Schemas Every schema this endpoint uses, each once; fields name the schema they hold. ### AccountIdentification Type: `object` · Kind: ISO20022 · Source: [§ 4.1.1, PDF p. 2](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=2) Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. Fields: - `workspace`, `string` — Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. Constraints: maxLength 32. - `iban`, `string` — ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. Constraints: pattern `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`. - `other`, [`GenericIdentification`](#genericidentification) - `currency`, [`CurrencyCode`](#currencycode) ### AmountAndCurrencyExchange Type: `object` · Kind: ISO20022 Provides detailed information on the original amount. The [instructedAmount] property identifies the amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party and provides currency exchange information in case the instructed amount and/or currency is/are different from the entry amount and/or currency. The [transactionAmount] property identifies the amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party and provides currency exchange information in case the instructed amount and/or currency is/are different from the entry amount and/or currency. The [cunterValueAmount] property embbeds the set of elements used to provide the countervalue amount and currency exchange information. - This can be either the counter amount quoted in an FX deal, or the result of the currency information applied to an instructed amount, before deduction of charges. The [announcedPostingAmount] property specifies the amount of money, based on terms of corporate action event and balance of underlying securities, entitled to/from the account owner. - In some situations, this amount may alternatively be called entitled amount. Fields: - `instructedAmount`, [`AmountAndCurrencyExchangeDetails`](#amountandcurrencyexchangedetails) - `transactionAmount`, [`AmountAndCurrencyExchangeDetails`](#amountandcurrencyexchangedetails) - `counterValueAmount`, [`AmountAndCurrencyExchangeDetails`](#amountandcurrencyexchangedetails) - `announcedPostingAmount`, [`AmountAndCurrencyExchangeDetails`](#amountandcurrencyexchangedetails) - `proprietaryAmount`, array of [`AmountAndCurrencyExchangeDetails`](#amountandcurrencyexchangedetails) — Set of elements used to provide information on the original amount and currency exchange. ### AmountAndCurrencyExchangeDetails Type: `object` · Kind: ISO20022 ISO20022: details on amount and currency exchange The [amount] property is the amount of money to be exchanged against another amount of money in the counter currency. The [sourceCurency] property indicates the currency from which an amount is to be converted in a currency conversion. The [targetCurrency] property indicates the currency into which an amount is to be converted in a currency conversion. The [unitCurrency] indicates the currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. API: Amounts must always be set as positive values. Fields: - `type`, `string` — specifies the type of amount in case of proprietary amount Constraints: maxLength 35. - `amount`, [`AmountType`](#amounttype), required - `sourceCurrency`, [`CurrencyCode`](#currencycode), required - `targetCurrency`, [`CurrencyCode`](#currencycode) - `unitCurrency`, [`CurrencyCode`](#currencycode) - `exchangeRate`, `number (float)`, 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. ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). - `contractIdentification`, `string` — Unique identification to unambiguously identify the foreign exchange contract. Constraints: maxLength 35. - `quotationDate`, `string (date)` — Date and time at which an exchange rate is quoted. ### AmountType Type: `object` · Kind: ISO20022 · Source: [§ 4.1.2, PDF p. 2](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=2) Structure aiming to embed the amount and the currency to be used. Fields: - `amount`, `number (float)`, required — ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Constraints: pattern `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`. - `currency`, [`CurrencyCode`](#currencycode), required ### BankTransactionCode Type: `object` · Kind: ISO20022 Set of elements used to fully identify the type of underlying transaction resulting in an entry. ISO20022 provides a list of [possible Bank Transaction Code combinations](https://www.iso20022.org/external_code_list.page) Transaction codification might also be specified at national community level. For instance a French Transaction codification is [available](https://www.cfonb.org/fichiers/20190913092943_Brochure_Codes_Operation_pour_restitutions_clienteles_V5_0_novembre_2018.pdf) It applies with paragraph 2 code table using the following mapping: - domain must be set with "FR" - family must be set with one of the values that are provided in the [code Famille] column (e.g. "OPCA") - subFamily must be set with one of the values that are provided in the [code operation] column (e.g. "05") - code might be set with a proprietary transaction code that must be documented by the implementation. Fields: - `domain`, `string`, required — Set of elements used to provide the domain, the family and the sub-family of the bank transaction code, in a structured and hierarchical format. Constraints: maxLength 4. - `family`, `string`, required — Specifies the family and the sub-family of the bank transaction code, within a specific domain, in a structured and hierarchical format. Constraints: maxLength 4. - `subFamily`, `string`, required — Specifies the sub-product family within a specific family. Constraints: maxLength 4. - `code`, `string` — Proprietary bank transaction code to identify the underlying transaction. Constraints: maxLength 35. - `issuer`, `string` — Identification of the issuer of the proprietary bank transaction code. Constraints: maxLength 35. ### ChargeBearerCode Type: `string` · Kind: ISO20022 ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed: Values: - `DEBT` — BorneByDebtor: All transaction charges are to be borne by the debtor. - `CRED` — BorneByCreditor: All transaction charges are to be borne by the creditor. - `SHAR` — Shared: In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. - `SLEV` — FollowingServiceLevel: Charges are to be applied following the rules agreed in the service level and/or scheme. ### Charges Type: `object` · Kind: ISO20022 ISO20022: Provides further details on the charges related to the payment transaction. API: Amounts must always be set as positive values. Fields: - `totalChargesAndTaxAmount`, [`AmountType`](#amounttype) — Total of all charges and taxes applied to the entry. - `record`, array of [`ChargesRecord`](#chargesrecord) — Provides details of the individual charges record. ### ChargesRecord Type: `object` · Kind: ISO20022 ISO20022: Provides further individual record details on the charges related to the payment transaction. - The [amount] proprty specifies the transaction charges to be paid by the charge bearer. - The [creditDebitIndicator] property indicates whether the charges amount is a credit or a debit amount. A zero amount is considered to be a credit. - the [code] property is the charge type, in a coded form - the [rate] property is the rate used to calculate the amount of the charge or fee. - the [bearer] property specifies which party/parties will bear the charges associated with the processing of the payment transaction. - the [agent] property specifies the agent that takes the transaction charges or to which the transaction charges are due. - the [tax] property provides details on the tax applied to charges. API: Amounts must always be set as positive values. Fields: - `amount`, [`AmountType`](#amounttype) - `creditDebitIndicator`, [`CreditDebitIndicator`](#creditdebitindicator) - `chargeIncludedIndicator`, `boolean` — Indicates whether the charge should be included in the amount or is added as pre-advice. One of the following values must be used: - Meaning When True: Included - Meaning When False: Pre-advised - `code`, [`CodeAndIssuer`](#codeandissuer) - `rate`, [`PercentageRate`](#percentagerate) - `bearer`, [`ChargeBearerCode`](#chargebearercode) - `agent`, [`FinancialInstitutionIdentification`](#financialinstitutionidentification) - `tax`, [`TaxCharges`](#taxcharges) ### ClearingSystemMemberIdentification Type: `object` · Kind: ISO20022 ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify the beneficiary bank Fields: - `clearingSystemId`, `string`, required — ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Constraints: maxLength 35. - `memberId`, `string`, required — ISO20022: Identification of a member of a clearing system. Constraints: maxLength 35. ### CodeAndIssuer Type: `object` · Kind: ISO20022 Specifies a code and the issuer of this code. Fields: - `code`, `string`, required — Provides the code. Constraints: maxLength 4. - `issuer`, `string` — Identification of the issuer of the code. Constraints: maxLength 35. ### ContactDetails Type: `object` · Kind: ISO20022 Indicates how to contact the party. Fields: - `phoneNumber`, [`PhoneNumber`](#phonenumber) - `faxNumber`, [`PhoneNumber`](#phonenumber) - `emailAddress`, `string` — email address of the contact Constraints: maxLength 2048, pattern `^.+@.+$`. ### CreditDebitIndicator Type: `string` · Kind: ISO20022 Accounting flow of the amount Values: - `CRDT` — Credit type amount - `DBIT` — Debit type amount ### CreditorReferenceInformation Type: `object` · Kind: ISO20022 Reference information provided by the creditor to allow the identification of the underlying documents. Fields: - `type`, [`CodeAndIssuer`](#codeandissuer) - `reference`, `string` — Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Constraints: maxLength 35. ### CurrencyCode Type: `string` · Kind: ISO20022 · Constraints: pattern `^[A-Z]{3,3}$` Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". ### DateAndPlaceOfBirth Type: `object` · Kind: ISO20022 Date and place of birth of a person. This information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment. Fields: - `birthDate`, `string (date)`, required — Date on which a person is born. - `cityOfBirth`, `string`, required — City where a person was born. Constraints: maxLength 35. - `countryOfBirth`, `string`, required — Country where a person was born. Constraints: pattern `^[A-Z]{2,2}$`. ### DocumentAdjustment Type: `object` · Kind: ISO20022 ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values. Fields: - `amount`, [`AmountType`](#amounttype), required - `creditDebitIndicator`, [`CreditDebitIndicator`](#creditdebitindicator) - `reason`, `string` — Specifies the reason for the adjustment. Constraints: maxLength 4. - `additionalInformation`, `string` — Provides further details on the document adjustment. Constraints: maxLength 140. ### DocumentLineIdentification Type: `object` · Kind: ISO20022 Provides identification of the document line. the [type] property must be used for specifying the type of referred document type. Fields: - `type`, [`CodeAndIssuer`](#codeandissuer) - `number`, `string` — Unique and unambiguous identification of the referred document line. Constraints: maxLength 35. - `relatedDate`, `string (date)` — Date associated with the referred document line. ### EndDate Type: `string (date-time)` · Kind: ISO20022 The last applicable day of execution for a given period. If not given, the period is considered as endless. ### EndToEndId Type: `string` · Constraints: pattern `^([a-zA-Z0-9 /\-?:\()\.,']{1,36})$` ISO20022: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. ### ErrorDetail Type: `object` · Kind: Technical detailed error description Fields: - `location`, `string` — Location of the erroneous parameter when not in request body Values: - `header` - `query` - `name`, `string` — Name of the erroneous parameter when not in request body - `path`, `string` — JsonPath of the erroneous request body property - `erroneousValue`, `string` — Erroneous parameter value - `message`, `string` — Relevant message for the erroneous parameter - `expectedPattern`, `string` — Expected pattern, if any, that the erroneous parameter does not match with - `expectedValueRange`, `object` — Expected value range, if any, that the erroneous parameter does not match with - `minValue`, `integer` - `maxValue`, `integer` - `expectedValueCount`, `object` — Expected value count, in the case of an array item, that the erroneous parameter does not match with - `minValue`, `integer` - `maxValue`, `integer` - `expectedEnumeration`, array of `string` — Expected enumeration, if any, that the erroneous parameter do not match with ### ErrorModel Type: `object` · Kind: Technical Generic error report structure Fields: - `timestamp`, `string (date-time)` — current timestamp - `status`, `integer (int32)`, required — HTTP error code - `error`, `string` — HTTP error text Constraints: maxLength 140. - `message`, `string`, required — HTTP textual reason phrase Constraints: maxLength 140. - `path`, `string` — Relevant path that was used Constraints: maxLength 140. - `details`, array of [`ErrorDetail`](#errordetail) — list of detailed errors that were encountered ### ExecutionRule Type: `string` · Kind: ISO20022 Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the "preceding" or "following" working day. ASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting this execution rule. Values: - `FWNG` — following - `PREC` — preceding ### FinancialInstitutionIdentification Type: `object` · Kind: ISO20022 · Source: [§ 4.1.5, PDF p. 12](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=12) ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. Fields: - `bicFi`, `string`, required — ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)". Constraints: pattern `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`. - `clearingSystemMemberId`, [`ClearingSystemMemberIdentification`](#clearingsystemmemberidentification) - `lei`, [`LeiIdentification`](#leiidentification) - `name`, `string` — Name of the financial institution Constraints: maxLength 140. - `postalAddress`, [`PostalAddress`](#postaladdress) ### FrequencyCode Type: `string` · Kind: ISO20022 Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. However, each ASPSP might restrict these values into a subset if needed. Values: - `DAIL` — Daily - `WEEK` — Weekly - `TOWK` — EveryTwoWeeks - `MNTH` — Monthly - `TOMN` — EveryTwoMonths - `QUTR` — Quarterly - `SEMI` — SemiAnnual - `YEAR` — Annual ### GenericIdentification Type: `object` · Kind: ISO20022 · Source: [§ 4.1.6, PDF p. 14](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=14) ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support. Fields: - `identification`, `string`, required — API: Identifier Constraints: maxLength 70. - `schemeName`, `string`, required — Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used Constraints: maxLength 70. - `issuer`, `string` — ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties Constraints: maxLength 35. ### GenericLink Type: `object` · Kind: Hal · Source: [§ 4.1.7, PDF p. 15](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=15) hypertext reference Fields: - `href`, `string`, required — URI to be used. HREF stands for Hypertext REFerence. Constraints: maxLength 2000. - `templated`, `boolean` — This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false ### HalTransactions Type: `object` · Kind: Hal HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP Fields: - `transactions`, array of [`TransactionResource`](#transactionresource), required — List of transactions - `_links`, [`TransactionsLinks`](#transactionslinks), required ### LeiIdentification Type: `string` · Kind: ISO20022 · Constraints: pattern `^[A-Z0-9]{18,18}[0-9]{2,2}$` Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". ### LineDetail Type: `object` · Kind: ISO20022 Set of elements used to provide the content of the referred document line. Fields: - `identification`, [`DocumentLineIdentification`](#documentlineidentification) - `description`, `string` — Description associated with the document line. Constraints: maxLength 2048. - `amount`, [`RemittanceAmount`](#remittanceamount) ### PartyIdentification Type: `object` · Kind: ISO20022 · Source: [§ 4.1.8, PDF p. 15](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=15) API : Description of a Party which can be either a person or an organization. Fields: - `name`, `string`, required — ISO20022: Name by which a party is known and which is usually used to identify that party. The [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation. The [privateId] property allows the specification of an unique and unambiguous way to identify a person. Constraints: maxLength 140. - `dateAndPlaceOfBirth`, [`DateAndPlaceOfBirth`](#dateandplaceofbirth) - `postalAddress`, [`PostalAddress`](#postaladdress) - `contactDetails`, [`ContactDetails`](#contactdetails) - `organisationId`, [`GenericIdentification`](#genericidentification) - `privateId`, [`GenericIdentification`](#genericidentification) - `lei`, [`LeiIdentification`](#leiidentification) ### PercentageRate Type: `number (float)` · Kind: ISO20022 Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%. ### Period Type: `object` definition of a time period Fields: - `startDate`, [`StartDate`](#startdate) - `endDate`, [`EndDate`](#enddate) ### PhoneNumber Type: `string` · Kind: ISO20022 · Constraints: pattern `^\+[0-9]{1,3}-[0-9()+\-]{1,30}$` The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters). ### PostalAddress Type: `object` · Kind: ISO20022 ISO20022: Information that locates and identifies a specific address, as defined by postal services. Fields: - `addressType`, `string` — ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed. Values: - `BIZZ` — Business: Address is the business address - `DLVY` — Delivery: Address is the address to which delivery is to take place - `MLTO` — Mail To: Address is the address to which mail is sent - `PBOX` — PO Box: Address is is a postal office (PO) box - `ADDR` — Postal: Address is the complete postal address - `HOME` — Home: Address is the home address - `department`, `string` — ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments. Constraints: maxLength 70. - `subDepartment`, `string` — ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments. Constraints: maxLength 70. - `streetName`, `string` — ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments. Constraints: maxLength 70. - `buildingNumber`, `string` — ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments. Constraints: maxLength 16. - `buildingName`, `string` — ISO20022: Name of the building or house. API: Cannot be used for SEPA payments. Constraints: maxLength 16. - `postCode`, `string` — ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. API: Cannot be used for SEPA payments. Constraints: maxLength 16. - `townName`, `string` — ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments. Constraints: maxLength 35. - `countrySubDivision`, `string` — ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments. Constraints: maxLength 35. - `country`, `string`, required — ISO20022: Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed. Constraints: pattern `^([A-Z]{2,2})$`. - `addressLine`, array of `string` — Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed. Item constraints: maxLength 70. Items: Address line ### ReferredDocumentInformation Type: `object` · Kind: ISO20022 Provides the identification and the content of the referred document. Fields: - `type`, [`CodeAndIssuer`](#codeandissuer) - `number`, `string` — Unique and unambiguous identification of the referred document. Constraints: maxLength 35. - `relatedDate`, `string (date)` — Date associated with the referred document. - `lineDetails`, array of [`LineDetail`](#linedetail) — Sets of elements used to provide the content of the referred document line. ### ReferredDocumentInformations Type: array of [`ReferredDocumentInformation`](#referreddocumentinformation) · Kind: ISO20022 Provides the identification and the content of the referred documents. ### RelatedParties Type: `object` · Kind: ISO20022 information about the parties that are related to the transaction Fields: - `initiatingParty`, [`PartyIdentification`](#partyidentification) - `debtorAgent`, [`FinancialInstitutionIdentification`](#financialinstitutionidentification) - `debtor`, [`PartyIdentification`](#partyidentification) - `debtorAccount`, [`AccountIdentification`](#accountidentification) - `ultimateDebtor`, [`PartyIdentification`](#partyidentification) - `creditorAgent`, [`FinancialInstitutionIdentification`](#financialinstitutionidentification) - `creditor`, [`PartyIdentification`](#partyidentification) - `creditorAccount`, [`AccountIdentification`](#accountidentification) - `ultimateCreditor`, [`PartyIdentification`](#partyidentification) ### RemittanceAmount Type: `object` · Kind: ISO20022 ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | duePayableAmount | Amount specified is the exact amount due and payable to the creditor. | | discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. | | creditNoteAmount | Amount of a credit note. | | taxAmount | Amount of the tax. | | adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. | | remittedAmount | Amount of money remitted. | Fields: - `duePayableAmount`, [`AmountType`](#amounttype) - `discountAppliedAmount`, [`TypedAmount`](#typedamount) - `creditNoteAmount`, [`AmountType`](#amounttype) - `taxAmount`, [`TypedAmount`](#typedamount) - `adjustmentAmountAndReason`, [`DocumentAdjustment`](#documentadjustment) - `remittedAmount`, [`AmountType`](#amounttype) ### RemittanceInformation Type: `object` · Kind: ISO20022 ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. API: - Only one occurrence of the unstructured information is allowed. - Only one occurrence of the structured information is allowed. - Structured and unstructured information can coexist. Fields: - `unstructured`, array of `string` — Unstructured remittance information. Each implementation may add a pattern in order to specify its own character set constraints. Item constraints: maxLength 140. Items: Relevant information to the transaction - `structured`, array of [`StructuredRemittanceInformation`](#structuredremittanceinformation) — Structured remittance information ### ResourceId Type: `string` · Kind: Resources · Constraints: pattern `^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$` API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. However it is the duty of each ASPSP to perform its own risk analysis on this topic. ### StandingOrderCharacteristics Type: `object` · Kind: ISO20022 Specifies the characteristics of a standing order. Fields: - `startDate`, [`StartDate`](#startdate), required - `endDate`, [`EndDate`](#enddate) - `executionRule`, [`ExecutionRule`](#executionrule), required - `frequency`, [`FrequencyCode`](#frequencycode), required ### StartDate Type: `string (date-time)` · Kind: ISO20022 The first applicable day of execution for a given period. ### StructuredRemittanceInformation Type: `object` · Kind: ISO20022 · Source: [§ 4.1.12, PDF p. 22](https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf#page=22) Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form. Fields: - `referredDocumentInformation`, [`ReferredDocumentInformations`](#referreddocumentinformations) - `referredDocumentAmount`, [`RemittanceAmount`](#remittanceamount) - `creditorReferenceInformation`, [`CreditorReferenceInformation`](#creditorreferenceinformation) - `invoicer`, [`PartyIdentification`](#partyidentification) - `invoicee`, [`PartyIdentification`](#partyidentification) - `taxRemittance`, [`TaxInformation`](#taxinformation) ### TaxAmount Type: `object` · Kind: ISO20022 ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | rate | Rate used to calculate the tax. | | taxableBaseAmount | Amount of money on which the tax is based. | | totalAmount | Total amount that is the result of the calculation of the tax for the record. | | details | Set of elements used to provide details on the tax period and amount. | Fields: - `rate`, [`PercentageRate`](#percentagerate) - `taxableBaseAmount`, [`AmountType`](#amounttype) - `totalAmount`, [`AmountType`](#amounttype) - `details`, array of [`TaxRecordDetails`](#taxrecorddetails) — Set of elements used to provide details on the tax period and amount. ### TaxCharges Type: `object` · Kind: ISO20022 ISO20022: Provides details on the tax applied to charges. - The [rate] property is the rate used to calculate the tax. - the [amount] property is the amount of money resulting from the calculation of the tax. API: Amounts must always be set as positive values. Fields: - `identification`, `string` — Unique reference to unambiguously identify the nature of the tax levied, such as Value Added Tax (VAT). Constraints: maxLength 35. - `rate`, [`PercentageRate`](#percentagerate) - `amount`, [`AmountType`](#amounttype) ### TaxInformation Type: `object` · Kind: ISO20022 ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax. Fields: - `creditor`, [`TaxParty`](#taxparty) - `debtor`, [`TaxParty`](#taxparty) - `ultimateDebtor`, [`TaxParty`](#taxparty) - `administrationZone`, `string` — Territorial part of a country to which the tax payment is related. Constraints: maxLength 35. - `referenceNumber`, `string` — Tax reference information that is specific to a taxing agency. Constraints: maxLength 140. - `method`, `string` — Method used to indicate the underlying business or how the tax is paid. Constraints: maxLength 35. - `totalTaxableBaseAmount`, [`AmountType`](#amounttype) - `totalTaxAmount`, [`AmountType`](#amounttype) - `date`, `string (date)` — Date by which tax is due. - `sequenceNumber`, `integer (int32)` — Sequential number of the tax report. - `record`, array of [`TaxRecord`](#taxrecord) — Records of tax details ### TaxParty Type: `object` · Kind: ISO20022 Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party. Fields: - `taxIdentification`, `string` — Tax identification number of the party. Constraints: maxLength 35. - `registrationIdentification`, `string` — Unique identification, as assigned by an organisation, to unambiguously identify a party. Constraints: maxLength 35. - `taxType`, `string` — Type of tax payer. Constraints: maxLength 35. - `authorisation`, [`TitleAndName`](#titleandname) ### TaxPeriod Type: `object` · Kind: ISO20022 Set of elements used to provide details on the period of time related to the tax payment. The [type] property aims to identify the period related to the tax payment. Fields: - `year`, `string` — Year related to the tax payment. Constraints: pattern `^[0-9]{4,4}$`. - `type`, [`TaxRecordPeriodCode`](#taxrecordperiodcode) - `fromDate`, `string (date)` — Start date of the range. - `toDate`, `string (date)` — End date of the range. ### TaxRecord Type: `object` · Kind: ISO20022 Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record. Fields: - `type`, `string` — High level code to identify the type of tax details. Constraints: maxLength 35. - `category`, `string` — Specifies the tax code as published by the tax authority. Constraints: maxLength 35. - `categoryDetails`, `string` — Provides further details of the category tax code. Constraints: maxLength 35. - `debtorStatus`, `string` — Code provided by local authority to identify the status of the party that has drawn up the settlement document. Constraints: maxLength 35. - `certificateIdentification`, `string` — Identification number of the tax report as assigned by the taxing authority. Constraints: maxLength 35. - `formsCode`, `string` — Identifies, in a coded form, on which template the tax report is to be provided. Constraints: maxLength 35. - `period`, [`TaxPeriod`](#taxperiod) - `taxAmount`, [`TaxAmount`](#taxamount) - `additionalInformation`, `string` — Further details of the tax record. Constraints: maxLength 140. ### TaxRecordDetails Type: `object` · Kind: ISO20022 ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values. | Property | Description | | -------- | ----------- | | period | Set of elements used to provide details on the period of time related to the tax payment. | | amount | Underlying tax amount related to the specified period. | Fields: - `period`, [`TaxPeriod`](#taxperiod) - `amount`, [`AmountType`](#amounttype), required ### TaxRecordPeriodCode Type: `string` · Kind: ISO20022 Identification of the period related to the tax payment. Values: - `MM01` — FirstMonth Tax is related to the second month of the period. - `MM02` — SecondMonth Tax is related to the first month of the period. - `MM03` — ThirdMonth Tax is related to the third month of the period. - `MM04` — FourthMonth Tax is related to the fourth month of the period. - `MM05` — FifthMonth Tax is related to the fifth month of the period. - `MM06` — SixthMonth Tax is related to the sixth month of the period. - `MM07` — SeventhMonth Tax is related to the seventh month of the period. - `MM08` — EighthMonth Tax is related to the eighth month of the period. - `MM09` — NinthMonth Tax is related to the ninth month of the period. - `MM10` — TenthMonth Tax is related to the tenth month of the period. - `MM11` — EleventhMonth Tax is related to the eleventh month of the period. - `MM12` — TwelfthMonth Tax is related to the twelfth month of the period. - `QTR1` — FirstQuarter Tax is related to the first quarter of the period. - `QTR2` — SecondQuarter Tax is related to the second quarter of the period. - `QTR3` — ThirdQuarter Tax is related to the third quarter of the period. - `QTR4` — FourthQuarter Tax is related to the fourth quarter of the period. - `HLF1` — FirstHalf Tax is related to the first half of the period. - `HLF2` — SecondHalf Tax is related to the second half of the period. ### TitleAndName Type: `object` · Kind: ISO20022 Title and Name of the party or the party's authorised reprensentative. Fields: - `title`, `string` — Title or position of the party or the party's authorised reprensentative. Constraints: maxLength 35. - `name`, `string` — Name of the party or the party's authorised reprensentative. Constraints: maxLength 140. ### TransactionLinks Type: `object` · Kind: Hal links that can be used for further retrieving details on a given transaction | Link | Description | | ---- | ----------- | | details | link to the details of the transaction | Fields: - `details`, [`GenericLink`](#genericlink) ### TransactionResource Type: `object` · Kind: ISO20022 ISO20022: Structure of a transaction. - the [charges] property provides information on the charges, pre-advised or included in the entry amount. - the [relatedParties] property specifies either the debtor or the creditor counterpart information API: - Amounts must always be set as positive values in complement with the Credit/Debit indicator. - At least expectedBookingDate or bookingDate must be provided" Fields: - `resourceId`, [`ResourceId`](#resourceid) - `entryReference`, `string` — Technical incremental identification of the transaction used for reconciliation by the AISP. Once assigned, this value cannot be changed for the relevant transaction. It is assumed that this value is unique and thus cannot be shared by several transactions. The reconciliation of transactions can be done by the [resourceId] or the [entryReference] field. If none of these fields cannot be provided, it is therefore suggested that the [remittanceInformation] field, once set, should not be updated afterwards. Actually the [additionalTransactionInformation] field can be used to update the details of a given transaction. Constraints: maxLength 40. - `transactionAmount`, [`AmountType`](#amounttype), required - `creditDebitIndicator`, [`CreditDebitIndicator`](#creditdebitindicator), required - `transactionAmountDetails`, [`AmountAndCurrencyExchange`](#amountandcurrencyexchange) - `status`, [`TransactionStatus`](#transactionstatus), required - `endToEndId`, [`EndToEndId`](#endtoendid) - `expectedBookingDate`, `string (date-time)` — Expected booking date of the transaction on the account if the transaction is not yet booked. - `bookingDate`, `string (date-time)` — Real booking date of the transaction on the account - `valueDate`, `string (date-time)` — Value date of the transaction on the account - `transactionDate`, `string (date-time)` — Date used for specific purposes: - for card transaction: date of the commercial transaction - for credit transfer: acquiring date of the transaction as seen by the Payer's Bank - for direct debit: receiving date of the transaction as seen by the Payer's Bank - `bankTransactionCode`, [`BankTransactionCode`](#banktransactioncode) - `charges`, [`Charges`](#charges) - `relatedParties`, [`RelatedParties`](#relatedparties) - `remittanceInformation`, [`RemittanceInformation`](#remittanceinformation) - `additionalTransactionInformation`, `string` — Additional information about reconciliation. Constraints: maxLength 500. - `standingOrderCharacteristics`, [`StandingOrderCharacteristics`](#standingordercharacteristics) - `merchantCategoryCode`, `string` — Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. Constraints: maxLength 4. - `_links`, [`TransactionLinks`](#transactionlinks) - `bookingPeriod`, [`Period`](#period) - `cardId`, [`GenericIdentification`](#genericidentification) ### TransactionsLinks Type: `object` · Kind: Hal links that can be used for further navigation when browsing transactions Information at one account level | Link | Description | | ---- | ----------- | | self | link to the transactions of a given account | | parent-list | link to the list of all available accounts | | owners | link to the owners identities for a given account | | balances | link to the balances of a given account | | overdrafts | link to the lists of overdrafts of a given account | | first | link to the first page of the transactions result | | last | link to the last page of the transactions result | | next | link to the next page of the transactions result | | prev | link to the previous page of the transactions result | Fields: - `self`, [`GenericLink`](#genericlink), required - `parent-list`, [`GenericLink`](#genericlink) - `owners`, [`GenericLink`](#genericlink) - `balances`, [`GenericLink`](#genericlink) - `overdrafts`, [`GenericLink`](#genericlink) - `first`, [`GenericLink`](#genericlink) - `last`, [`GenericLink`](#genericlink) - `next`, [`GenericLink`](#genericlink) - `prev`, [`GenericLink`](#genericlink) ### TransactionStatus Type: `string` · Kind: ISO20022 Type of Transaction Values: - `BOOK` — ClosingBooked: Accounted transaction - `PDNG` — Pending: Transaction that is to be accounted and does already affect the instant balance - `FUTR` — Future: Entry is on the books of the account servicer and value will be applied to the account owner at a future date and time. - `INFO` — Information: Entry is only provided for information, and no booking on the account owner's account in the account servicer's ledger was performed. ### TypedAmount Type: `object` · Kind: ISO20022 ISO20022: Typed Amount API: Amounts must always be set as positive values. Fields: - `type`, `string` — Type of the amount Constraints: maxLength 35. - `amount`, [`AmountType`](#amounttype), required