obOpen Banking Lab
GlossaireSTETBlogContact
AISP

get/accounts/{accountResourceId}/transactions

Retrieval of an account transaction set (AISP)

OAuth2 scope: aisp

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 (24)

  • Authorizationheaderstringrequired

    Access token to be passed as a header

  • accountResourceIdpathstringrequired

    Identification of account resource to fetch

  • dateFromquerystring

    Inclusive minimal imputation date of the transactions.

    Transactions having an imputation date equal to this parameter are included within the result.

  • dateToquerystring

    Exclusive maximal imputation date of the transactions.

    Transactions having an imputation date equal to this parameter are not included within the result.

  • dateTypequerystring

    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.

  • entryReferenceFromquerystring

    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

  • entryReferencetoquerystring

    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

  • PSU-IP-Addressheaderstring

    IP address used by the PSU's terminal when connecting to the TPP

  • PSU-IP-Portheaderstring

    IP port used by the PSU's terminal when connecting to the TPP

  • PSU-HTTP-Methodheaderstring

    Http method for the most relevant PSU's terminal request to the TTP

  • PSU-Dateheaderstring

    Timestamp of the most relevant PSU's terminal request to the TTP

  • PSU-GEO-Locationheaderstring

    Geographical location of the PSU as provided by the PSU mobile terminal if any to the TPP

  • PSU-User-Agentheaderstring

    "User-Agent" header field sent by the PSU terminal when connecting to the TPP

  • PSU-Refererheaderstring

    "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-Acceptheaderstring

    "Accept" header field sent by the PSU terminal when connecting to the TPP

  • PSU-Accept-Charsetheaderstring

    "Accept-Charset" header field sent by the PSU terminal when connecting to the TPP

  • PSU-Accept-Encodingheaderstring

    "Accept-Encoding" header field sent by the PSU terminal when connecting to the TPP

  • PSU-Accept-Languageheaderstring

    "Accept-Language" header field sent by the PSU terminal when connecting to the TPP

  • PSU-Device-IDheaderstring

    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.

  • Digestheaderstring

    Digest of the body

  • Signatureheaderstring

    http-signature of the request 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-IDheaderstringrequired

    Correlation header to be set in a request and retrieved in the relevant response

  • workspacequerystring

    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.

  • X-JWS-Signatureheaderstring

    JSON WEB signature of the request

Responses

200

Complete transactions response

Halobject

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields (2)

  • transactionsarray<TransactionResource>required

    List of transactions

    Item: TransactionResource

    • resourceIdResourceId

      Schema: ResourceId

    • entryReferencestring

      Technical incremental identification of the transaction used for reconciliation by the AISP.

      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

    • transactionAmountAmountTyperequired

      Schema: AmountType

      • amountnumber (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.

        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}$`

      • currencyCurrencyCoderequired

        Schema: CurrencyCode

    • creditDebitIndicatorCreditDebitIndicatorrequired

      Schema: CreditDebitIndicator

      CodeNameDescription
      CRDT
      		Credit type amount—
      DBIT
      		Debit type amount—
    • transactionAmountDetailsAmountAndCurrencyExchange

      Schema: AmountAndCurrencyExchange

      • instructedAmountAmountAndCurrencyExchangeDetails

        Schema: AmountAndCurrencyExchangeDetails

        • typestring

          specifies the type of amount in case of proprietary amount

          Constraints: maxLength: 35

        • amountAmountTyperequired

          Schema: AmountType

        • sourceCurrencyCurrencyCoderequired

          Schema: CurrencyCode

        • targetCurrencyCurrencyCode

          Schema: CurrencyCode

        • unitCurrencyCurrencyCode

          Schema: CurrencyCode

        • exchangeRatenumber (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.

          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).

        • contractIdentificationstring

          Unique identification to unambiguously identify the foreign exchange contract.

          Constraints: maxLength: 35

        • quotationDatestring (date)

          Date and time at which an exchange rate is quoted.

      • transactionAmountAmountAndCurrencyExchangeDetails

        Schema: AmountAndCurrencyExchangeDetails

        • typestring

          specifies the type of amount in case of proprietary amount

          Constraints: maxLength: 35

        • amountAmountTyperequired

          Schema: AmountType

        • sourceCurrencyCurrencyCoderequired

          Schema: CurrencyCode

        • targetCurrencyCurrencyCode

          Schema: CurrencyCode

        • unitCurrencyCurrencyCode

          Schema: CurrencyCode

        • exchangeRatenumber (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.

          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).

        • contractIdentificationstring

          Unique identification to unambiguously identify the foreign exchange contract.

          Constraints: maxLength: 35

        • quotationDatestring (date)

          Date and time at which an exchange rate is quoted.

      • counterValueAmountAmountAndCurrencyExchangeDetails

        Schema: AmountAndCurrencyExchangeDetails

        • typestring

          specifies the type of amount in case of proprietary amount

          Constraints: maxLength: 35

        • amountAmountTyperequired

          Schema: AmountType

        • sourceCurrencyCurrencyCoderequired

          Schema: CurrencyCode

        • targetCurrencyCurrencyCode

          Schema: CurrencyCode

        • unitCurrencyCurrencyCode

          Schema: CurrencyCode

        • exchangeRatenumber (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.

          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).

        • contractIdentificationstring

          Unique identification to unambiguously identify the foreign exchange contract.

          Constraints: maxLength: 35

        • quotationDatestring (date)

          Date and time at which an exchange rate is quoted.

      • announcedPostingAmountAmountAndCurrencyExchangeDetails

        Schema: AmountAndCurrencyExchangeDetails

        • typestring

          specifies the type of amount in case of proprietary amount

          Constraints: maxLength: 35

        • amountAmountTyperequired

          Schema: AmountType

        • sourceCurrencyCurrencyCoderequired

          Schema: CurrencyCode

        • targetCurrencyCurrencyCode

          Schema: CurrencyCode

        • unitCurrencyCurrencyCode

          Schema: CurrencyCode

        • exchangeRatenumber (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.

          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).

        • contractIdentificationstring

          Unique identification to unambiguously identify the foreign exchange contract.

          Constraints: maxLength: 35

        • quotationDatestring (date)

          Date and time at which an exchange rate is quoted.

      • proprietaryAmountarray<AmountAndCurrencyExchangeDetails>

        Set of elements used to provide information on the original amount and currency exchange.

        Set of elements used to provide information on the original amount and currency exchange.

        Item: AmountAndCurrencyExchangeDetails

        • typestring

          specifies the type of amount in case of proprietary amount

          Constraints: maxLength: 35

        • amountAmountTyperequired

          Schema: AmountType

        • sourceCurrencyCurrencyCoderequired

          Schema: CurrencyCode

        • targetCurrencyCurrencyCode

          Schema: CurrencyCode

        • unitCurrencyCurrencyCode

          Schema: CurrencyCode

        • exchangeRatenumber (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.

          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).

        • contractIdentificationstring

          Unique identification to unambiguously identify the foreign exchange contract.

          Constraints: maxLength: 35

        • quotationDatestring (date)

          Date and time at which an exchange rate is quoted.

    • statusTransactionStatusrequired

      Schema: TransactionStatus

      CodeNameDescription
      BOOK
      		ClosingBookedAccounted transaction
      PDNG
      		PendingTransaction that is to be accounted and does already affect the instant balance
      FUTR
      		FutureEntry is on the books of the account servicer and value will be applied to the account owner at a future date and time.
      INFO
      		InformationEntry is only provided for information, and no booking on the account owner's account in the account servicer's ledger was performed.
    • endToEndIdEndToEndId

      Schema: EndToEndId

    • expectedBookingDatestring (date-time)

      Expected booking date of the transaction on the account if the transaction is not yet booked.

      Expected booking date of the transaction on the account if the transaction is not yet booked.

    • bookingDatestring (date-time)

      Real booking date of the transaction on the account

      Real booking date of the transaction on the account

    • valueDatestring (date-time)

      Value date of the transaction on the account

    • transactionDatestring (date-time)

      Date used for specific purposes:

      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
    • bankTransactionCodeBankTransactionCode

      Schema: BankTransactionCode

      • domainstringrequired

        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.

        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

      • familystringrequired

        Specifies the family and the sub-family of the bank transaction code, within a specific domain, in a structured and hierarchical format.

        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

      • subFamilystringrequired

        Specifies the sub-product family within a specific family.

        Specifies the sub-product family within a specific family.

        Constraints: maxLength: 4

      • codestring

        Proprietary bank transaction code to identify the underlying transaction.

        Proprietary bank transaction code to identify the underlying transaction.

        Constraints: maxLength: 35

      • issuerstring

        Identification of the issuer of the proprietary bank transaction code.

        Identification of the issuer of the proprietary bank transaction code.

        Constraints: maxLength: 35

    • chargesCharges

      Schema: Charges

      • totalChargesAndTaxAmountAmountType

        Total of all charges and taxes applied to the entry.

        Schema: AmountType

        • amountnumber (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.

          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}$`

        • currencyCurrencyCoderequired

          Schema: CurrencyCode

      • recordarray<ChargesRecord>

        Provides details of the individual charges record.

        Item: ChargesRecord

        • amountAmountType

          Schema: AmountType

        • creditDebitIndicatorCreditDebitIndicator

          Schema: CreditDebitIndicator

        • chargeIncludedIndicatorboolean

          Indicates whether the charge should be included in the amount or is added as pre-advice.

          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
        • codeCodeAndIssuer

          Schema: CodeAndIssuer

        • ratePercentageRate

          Schema: PercentageRate

        • bearerChargeBearerCode

          Schema: ChargeBearerCode

        • agentFinancialInstitutionIdentification

          Schema: FinancialInstitutionIdentification

        • taxTaxCharges

          Schema: TaxCharges

    • relatedPartiesRelatedParties

      Schema: RelatedParties

      • initiatingPartyPartyIdentification

        Schema: PartyIdentification

        • namestringrequired

          ISO20022: Name by which a party is known and which is usually used to identify that party.

          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

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Schema: DateAndPlaceOfBirth

        • postalAddressPostalAddress

          Schema: PostalAddress

        • contactDetailsContactDetails

          Schema: ContactDetails

        • organisationIdGenericIdentification

          Schema: GenericIdentification

        • privateIdGenericIdentification

          Schema: GenericIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

      • debtorAgentFinancialInstitutionIdentification

        Schema: FinancialInstitutionIdentification

        • bicFistringrequired

          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)".

          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}$`

        • clearingSystemMemberIdClearingSystemMemberIdentification

          Schema: ClearingSystemMemberIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

        • namestring

          Name of the financial institution

          Constraints: maxLength: 140

        • postalAddressPostalAddress

          Schema: PostalAddress

      • debtorPartyIdentification

        Schema: PartyIdentification

        • namestringrequired

          ISO20022: Name by which a party is known and which is usually used to identify that party.

          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

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Schema: DateAndPlaceOfBirth

        • postalAddressPostalAddress

          Schema: PostalAddress

        • contactDetailsContactDetails

          Schema: ContactDetails

        • organisationIdGenericIdentification

          Schema: GenericIdentification

        • privateIdGenericIdentification

          Schema: GenericIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

      • debtorAccountAccountIdentification

        Schema: AccountIdentification

        • workspacestring

          Workspace to which the account is linked.

          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

        • ibanstring

          ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

          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}$`

        • otherGenericIdentification

          Schema: GenericIdentification

        • currencyCurrencyCode

          Schema: CurrencyCode

      • ultimateDebtorPartyIdentification

        Schema: PartyIdentification

        • namestringrequired

          ISO20022: Name by which a party is known and which is usually used to identify that party.

          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

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Schema: DateAndPlaceOfBirth

        • postalAddressPostalAddress

          Schema: PostalAddress

        • contactDetailsContactDetails

          Schema: ContactDetails

        • organisationIdGenericIdentification

          Schema: GenericIdentification

        • privateIdGenericIdentification

          Schema: GenericIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

      • creditorAgentFinancialInstitutionIdentification

        Schema: FinancialInstitutionIdentification

        • bicFistringrequired

          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)".

          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}$`

        • clearingSystemMemberIdClearingSystemMemberIdentification

          Schema: ClearingSystemMemberIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

        • namestring

          Name of the financial institution

          Constraints: maxLength: 140

        • postalAddressPostalAddress

          Schema: PostalAddress

      • creditorPartyIdentification

        Schema: PartyIdentification

        • namestringrequired

          ISO20022: Name by which a party is known and which is usually used to identify that party.

          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

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Schema: DateAndPlaceOfBirth

        • postalAddressPostalAddress

          Schema: PostalAddress

        • contactDetailsContactDetails

          Schema: ContactDetails

        • organisationIdGenericIdentification

          Schema: GenericIdentification

        • privateIdGenericIdentification

          Schema: GenericIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

      • creditorAccountAccountIdentification

        Schema: AccountIdentification

        • workspacestring

          Workspace to which the account is linked.

          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

        • ibanstring

          ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

          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}$`

        • otherGenericIdentification

          Schema: GenericIdentification

        • currencyCurrencyCode

          Schema: CurrencyCode

      • ultimateCreditorPartyIdentification

        Schema: PartyIdentification

        • namestringrequired

          ISO20022: Name by which a party is known and which is usually used to identify that party.

          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

        • dateAndPlaceOfBirthDateAndPlaceOfBirth

          Schema: DateAndPlaceOfBirth

        • postalAddressPostalAddress

          Schema: PostalAddress

        • contactDetailsContactDetails

          Schema: ContactDetails

        • organisationIdGenericIdentification

          Schema: GenericIdentification

        • privateIdGenericIdentification

          Schema: GenericIdentification

        • leiLeiIdentification

          Schema: LeiIdentification

    • remittanceInformationRemittanceInformation

      Schema: RemittanceInformation

    • additionalTransactionInformationstring

      Additional information about reconciliation.

      Constraints: maxLength: 500

    • standingOrderCharacteristicsStandingOrderCharacteristics

      Schema: StandingOrderCharacteristics

      • startDateStartDaterequired

        Schema: StartDate

      • endDateEndDate

        Schema: EndDate

      • executionRuleExecutionRulerequired

        Schema: ExecutionRule

        CodeNameDescription
        FWNG
        		following—
        PREC
        		preceding—
      • frequencyFrequencyCoderequired

        Schema: FrequencyCode

        CodeNameDescription
        DAIL
        		Daily—
        WEEK
        		Weekly—
        TOWK
        		EveryTwoWeeks—
        MNTH
        		Monthly—
        TOMN
        		EveryTwoMonths—
        QUTR
        		Quarterly—
        SEMI
        		SemiAnnual—
        YEAR
        		Annual—
    • merchantCategoryCodestring

      Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

      Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

      Constraints: maxLength: 4

    • bookingPeriodPeriod

      Schema: Period

    • cardIdGenericIdentification

      Schema: GenericIdentification

      • identificationstringrequired

        API: Identifier

        API: Identifier

        Constraints: maxLength: 70

      • schemeNamestringrequired

        Name of the identification scheme.

        Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

        CodeNameDescription
        BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
        BBANBBANIdentifierBasic 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.
        COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
        SRENSIRENThe 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.
        SRETSIRETThe 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.
        NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
        Other values are also permitted, for instance:
        CodeNameDescription
        -------------------
        OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
        CPANCardPanCard PAN
        MPANMaskedPanCard PAN where some digits were replaced for security reason
        TPANTokenizedPanToken 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
        TBANTokenizedIBANToken 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

      • issuerstring

        ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

        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

204

No content.

Shared response definition: 204

400

Invalid status value

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

401

Unauthorized, authentication failure.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

403

Forbidden, authentication successful but access to resource is not allowed.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

404

Not found, no request available.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

405

Method Not Allowed.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

406

Not Acceptable.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

408

Request Timeout.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

429

Too many requests.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

500

Internal server error.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

503

Service unavailable.

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item: ErrorDetail

    • locationstringenum · 2

      Location of the erroneous parameter when not in request body

      CodeNameDescription
      header
      		——
      query
      		——
    • namestring

      Name of the erroneous parameter when not in request body

    • pathstring

      JsonPath of the erroneous request body property

    • erroneousValuestring

      Erroneous parameter value

    • messagestring

      Relevant message for the erroneous parameter

    • expectedPatternstring

      Expected pattern, if any, that the erroneous parameter does not match with

    • expectedValueRangeobject

      Expected value range, if any, that the erroneous parameter does not match with

    • expectedValueCountobject

      Expected value count, in the case of an array item, that the erroneous parameter does not match with

    • expectedEnumerationarray<string>

      Expected enumeration, if any, that the erroneous parameter do not match with

Schemas used by this endpoint

Every structure referenced by this operation, listed once. Cross-references resolve to anchors on this page.

ISO20022object§ 4.1.1 · PDF p. 2

AccountIdentification

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 (4)

  • workspacestring

    Workspace to which the account is linked.

    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

  • ibanstring

    ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

    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}$`

  • otherGenericIdentification

    Schema: GenericIdentification

  • currencyCurrencyCode

    Schema: CurrencyCode

ISO20022object

AmountAndCurrencyExchange

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 (5)

ISO20022object

AmountAndCurrencyExchangeDetails

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 (8)

  • typestring

    specifies the type of amount in case of proprietary amount

    Constraints: maxLength: 35

  • amountAmountTyperequired

    Schema: AmountType

  • sourceCurrencyCurrencyCoderequired

    Schema: CurrencyCode

  • targetCurrencyCurrencyCode

    Schema: CurrencyCode

  • unitCurrencyCurrencyCode

    Schema: CurrencyCode

  • exchangeRatenumber (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.

    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).

  • contractIdentificationstring

    Unique identification to unambiguously identify the foreign exchange contract.

    Constraints: maxLength: 35

  • quotationDatestring (date)

    Date and time at which an exchange rate is quoted.

ISO20022object§ 4.1.2 · PDF p. 2

AmountType

Structure aiming to embed the amount and the currency to be used.

Fields (2)

  • amountnumber (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.

    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}$`

  • currencyCurrencyCoderequired

    Schema: CurrencyCode

ISO20022object

BankTransactionCode

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

Transaction codification might also be specified at national community level.

For instance a French Transaction codification is available

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 (5)

  • domainstringrequired

    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.

    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

  • familystringrequired

    Specifies the family and the sub-family of the bank transaction code, within a specific domain, in a structured and hierarchical format.

    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

  • subFamilystringrequired

    Specifies the sub-product family within a specific family.

    Specifies the sub-product family within a specific family.

    Constraints: maxLength: 4

  • codestring

    Proprietary bank transaction code to identify the underlying transaction.

    Proprietary bank transaction code to identify the underlying transaction.

    Constraints: maxLength: 35

  • issuerstring

    Identification of the issuer of the proprietary bank transaction code.

    Identification of the issuer of the proprietary bank transaction code.

    Constraints: maxLength: 35

ISO20022string

ChargeBearerCode

ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. The following values are allowed:

CodeNameDescription
DEBT
BorneByDebtorAll transaction charges are to be borne by the debtor.
CRED
BorneByCreditorAll transaction charges are to be borne by the creditor.
SHAR
SharedIn 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
FollowingServiceLevelCharges are to be applied following the rules agreed in the service level and/or scheme.
ISO20022object

Charges

ISO20022: Provides further details on the charges related to the payment transaction. API: Amounts must always be set as positive values.

Fields (2)

  • totalChargesAndTaxAmountAmountType

    Total of all charges and taxes applied to the entry.

    Schema: AmountType

  • recordarray<ChargesRecord>

    Provides details of the individual charges record.

    Item schema: ChargesRecord

ISO20022object

ChargesRecord

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 (8)

  • amountAmountType

    Schema: AmountType

  • creditDebitIndicatorCreditDebitIndicator

    Schema: CreditDebitIndicator

  • chargeIncludedIndicatorboolean

    Indicates whether the charge should be included in the amount or is added as pre-advice.

    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
  • codeCodeAndIssuer

    Schema: CodeAndIssuer

  • ratePercentageRate

    Schema: PercentageRate

  • bearerChargeBearerCode

    Schema: ChargeBearerCode

  • agentFinancialInstitutionIdentification

    Schema: FinancialInstitutionIdentification

  • taxTaxCharges

    Schema: TaxCharges

ISO20022object

ClearingSystemMemberIdentification

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 (2)

  • clearingSystemIdstringrequired

    ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

    ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

    Constraints: maxLength: 35

  • memberIdstringrequired

    ISO20022: Identification of a member of a clearing system.

    ISO20022: Identification of a member of a clearing system.

    Constraints: maxLength: 35

ISO20022object

CodeAndIssuer

Specifies a code and the issuer of this code.

Fields (2)

  • codestringrequired

    Provides the code.

    Constraints: maxLength: 4

  • issuerstring

    Identification of the issuer of the code.

    Constraints: maxLength: 35

ISO20022object

ContactDetails

Indicates how to contact the party.

Fields (3)

  • phoneNumberPhoneNumber

    Schema: PhoneNumber

  • faxNumberPhoneNumber

    Schema: PhoneNumber

  • emailAddressstring

    email address of the contact

    Constraints: maxLength: 2048 · pattern: `^.+@.+$`

ISO20022string

CreditDebitIndicator

Accounting flow of the amount

CodeNameDescription
CRDT
Credit type amount—
DBIT
Debit type amount—
ISO20022object

CreditorReferenceInformation

Reference information provided by the creditor to allow the identification of the underlying documents.

Fields (2)

  • typeCodeAndIssuer

    Schema: CodeAndIssuer

  • referencestring

    Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

    Constraints: maxLength: 35

ISO20022string

CurrencyCode

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".

ISO20022object

DateAndPlaceOfBirth

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 (3)

  • birthDatestring (date)required

    Date on which a person is born.

  • cityOfBirthstringrequired

    City where a person was born.

    Constraints: maxLength: 35

  • countryOfBirthstringrequired

    Country where a person was born.

    Constraints: pattern: `^[A-Z]{2,2}$`

ISO20022object

DocumentAdjustment

ISO20022: Specifies detailed information on the amount and reason of the adjustment. API: Amounts must always be set as positive values.

Fields (4)

  • amountAmountTyperequired

    Schema: AmountType

  • creditDebitIndicatorCreditDebitIndicator

    Schema: CreditDebitIndicator

  • reasonstring

    Specifies the reason for the adjustment.

    Constraints: maxLength: 4

  • additionalInformationstring

    Provides further details on the document adjustment.

    Constraints: maxLength: 140

ISO20022object

DocumentLineIdentification

Provides identification of the document line. the [type] property must be used for specifying the type of referred document type.

Fields (3)

  • typeCodeAndIssuer

    Schema: CodeAndIssuer

  • numberstring

    Unique and unambiguous identification of the referred document line.

    Constraints: maxLength: 35

  • relatedDatestring (date)

    Date associated with the referred document line.

ISO20022string

EndDate

The last applicable day of execution for a given period. If not given, the period is considered as endless.

string

EndToEndId

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.

Technicalobject

ErrorDetail

detailed error description

Fields (9)

  • locationstringenum · 2

    Location of the erroneous parameter when not in request body

    CodeNameDescription
    header
    		——
    query
    		——
  • namestring

    Name of the erroneous parameter when not in request body

  • pathstring

    JsonPath of the erroneous request body property

  • erroneousValuestring

    Erroneous parameter value

  • messagestring

    Relevant message for the erroneous parameter

  • expectedPatternstring

    Expected pattern, if any, that the erroneous parameter does not match with

  • expectedValueRangeobject

    Expected value range, if any, that the erroneous parameter does not match with

  • expectedValueCountobject

    Expected value count, in the case of an array item, that the erroneous parameter does not match with

  • expectedEnumerationarray<string>

    Expected enumeration, if any, that the erroneous parameter do not match with

Technicalobject

ErrorModel

Generic error report structure

Fields (6)

  • timestampstring (date-time)

    current timestamp

  • statusinteger (int32)required

    HTTP error code

  • errorstring

    HTTP error text

    Constraints: maxLength: 140

  • messagestringrequired

    HTTP textual reason phrase

    Constraints: maxLength: 140

  • pathstring

    Relevant path that was used

    Constraints: maxLength: 140

  • detailsarray<ErrorDetail>

    list of detailed errors that were encountered

    Item schema: ErrorDetail

ISO20022string

ExecutionRule

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.

CodeNameDescription
FWNG
following—
PREC
preceding—
ISO20022object§ 4.1.5 · PDF p. 12

FinancialInstitutionIdentification

ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

Fields (5)

  • bicFistringrequired

    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)".

    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}$`

  • clearingSystemMemberIdClearingSystemMemberIdentification

    Schema: ClearingSystemMemberIdentification

  • leiLeiIdentification

    Schema: LeiIdentification

  • namestring

    Name of the financial institution

    Constraints: maxLength: 140

  • postalAddressPostalAddress

    Schema: PostalAddress

ISO20022string

FrequencyCode

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.

CodeNameDescription
DAIL
Daily—
WEEK
Weekly—
TOWK
EveryTwoWeeks—
MNTH
Monthly—
TOMN
EveryTwoMonths—
QUTR
Quarterly—
SEMI
SemiAnnual—
YEAR
Annual—
ISO20022object§ 4.1.6 · PDF p. 14

GenericIdentification

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 (3)

  • identificationstringrequired

    API: Identifier

    API: Identifier

    Constraints: maxLength: 70

  • schemeNamestringrequired

    Name of the identification scheme.

    Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

    CodeNameDescription
    BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
    BBANBBANIdentifierBasic 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.
    COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
    SRENSIRENThe 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.
    SRETSIRETThe 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.
    NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
    Other values are also permitted, for instance:
    CodeNameDescription
    -------------------
    OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
    CPANCardPanCard PAN
    MPANMaskedPanCard PAN where some digits were replaced for security reason
    TPANTokenizedPanToken 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
    TBANTokenizedIBANToken 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

  • issuerstring

    ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

    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

Halobject

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields (2)

ISO20022string

LeiIdentification

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

ISO20022object

LineDetail

Set of elements used to provide the content of the referred document line.

Fields (3)

  • identificationDocumentLineIdentification

    Schema: DocumentLineIdentification

  • descriptionstring

    Description associated with the document line.

    Constraints: maxLength: 2048

  • amountRemittanceAmount

    Schema: RemittanceAmount

ISO20022object§ 4.1.8 · PDF p. 15

PartyIdentification

API : Description of a Party which can be either a person or an organization.

Fields (7)

  • namestringrequired

    ISO20022: Name by which a party is known and which is usually used to identify that party.

    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

  • dateAndPlaceOfBirthDateAndPlaceOfBirth

    Schema: DateAndPlaceOfBirth

  • postalAddressPostalAddress

    Schema: PostalAddress

  • contactDetailsContactDetails

    Schema: ContactDetails

  • organisationIdGenericIdentification

    Schema: GenericIdentification

  • privateIdGenericIdentification

    Schema: GenericIdentification

  • leiLeiIdentification

    Schema: LeiIdentification

ISO20022number

PercentageRate

Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.

object

Period

definition of a time period

Fields (2)

ISO20022string

PhoneNumber

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).

ISO20022object

PostalAddress

ISO20022: Information that locates and identifies a specific address, as defined by postal services.

Fields (11)

  • addressTypestringenum · 6

    ISO20022: Identifies the nature of the postal address.

    ISO20022: Identifies the nature of the postal address. API: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.

    CodeNameDescription
    BIZZBusinessAddress is the business address
    DLVYDeliveryAddress is the address to which delivery is to take place
    MLTOMail ToAddress is the address to which mail is sent
    PBOXPO BoxAddress is is a postal office (PO) box
    ADDRPostalAddress is the complete postal address
    HOMEHomeAddress is the home address
    CodeNameDescription
    BIZZ
    		——
    DLVY
    		——
    MLTO
    		——
    PBOX
    		——
    ADDR
    		——
    HOME
    		——
  • departmentstring

    ISO20022: Identification of a division of a large organisation or building.

    ISO20022: Identification of a division of a large organisation or building. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 70

  • subDepartmentstring

    ISO20022: Identification of a sub-division of a large organisation or building.

    ISO20022: Identification of a sub-division of a large organisation or building. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 70

  • streetNamestring

    ISO20022: Name of a street or thoroughfare.

    ISO20022: Name of a street or thoroughfare. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 70

  • buildingNumberstring

    ISO20022: Number that identifies the position of a building on a street.

    ISO20022: Number that identifies the position of a building on a street. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 16

  • buildingNamestring

    ISO20022: Name of the building or house.

    ISO20022: Name of the building or house. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 16

  • postCodestring

    ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

    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

  • townNamestring

    ISO20022: Name of a built-up area, with defined boundaries, and a local government.

    ISO20022: Name of a built-up area, with defined boundaries, and a local government. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 35

  • countrySubDivisionstring

    ISO20022: Identifies a subdivision of a country such as state, region, county.

    ISO20022: Identifies a subdivision of a country such as state, region, county. API: Cannot be used for SEPA payments.

    Constraints: maxLength: 35

  • countrystringrequired

    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.

    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})$`

  • addressLinearray<string>

    Unstructured address. The lines must embed zip code and town name.

    Unstructured address. The lines must embed zip code and town name. For SEPA payments, only two address lines are allowed.

ISO20022object

ReferredDocumentInformation

Provides the identification and the content of the referred document.

Fields (4)

  • typeCodeAndIssuer

    Schema: CodeAndIssuer

  • numberstring

    Unique and unambiguous identification of the referred document.

    Constraints: maxLength: 35

  • relatedDatestring (date)

    Date associated with the referred document.

  • lineDetailsarray<LineDetail>

    Sets of elements used to provide the content of the referred document line.

    Item schema: LineDetail

ISO20022array of ReferredDocumentInformation

ReferredDocumentInformations

Provides the identification and the content of the referred documents.

Items: ReferredDocumentInformation

ISO20022object

RemittanceAmount

ISO20022: Provides details on the amounts of the document line. API: Amounts must always be set as positive values.

PropertyDescription
duePayableAmountAmount specified is the exact amount due and payable to the creditor.
discountAppliedAmountAmount of discount to be applied to the amount due and payable to the creditor.
creditNoteAmountAmount of a credit note.
taxAmountAmount of the tax.
adjustmentAmountAndReasonSpecifies detailed information on the amount and reason of the adjustment.
remittedAmountAmount of money remitted.

Fields (6)

ISO20022object

RemittanceInformation

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 (2)

  • unstructuredarray<string>

    Unstructured remittance information.

    Unstructured remittance information. Each implementation may add a pattern in order to specify its own character set constraints.

  • structuredarray<StructuredRemittanceInformation>

    Structured remittance information

    Item schema: StructuredRemittanceInformation

Resourcesstring

ResourceId

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.

ISO20022object

StandingOrderCharacteristics

Specifies the characteristics of a standing order.

Fields (4)

ISO20022string

StartDate

The first applicable day of execution for a given period.

ISO20022object§ 4.1.12 · PDF p. 22

StructuredRemittanceInformation

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 (6)

ISO20022object

TaxAmount

ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values.

PropertyDescription
rateRate used to calculate the tax.
taxableBaseAmountAmount of money on which the tax is based.
totalAmountTotal amount that is the result of the calculation of the tax for the record.
detailsSet of elements used to provide details on the tax period and amount.

Fields (4)

  • ratePercentageRate

    Schema: PercentageRate

  • taxableBaseAmountAmountType

    Schema: AmountType

  • totalAmountAmountType

    Schema: AmountType

  • detailsarray<TaxRecordDetails>

    Set of elements used to provide details on the tax period and amount.

    Item schema: TaxRecordDetails

ISO20022object

TaxCharges

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 (3)

  • identificationstring

    Unique reference to unambiguously identify the nature of the tax levied, such as Value Added Tax (VAT).

    Constraints: maxLength: 35

  • ratePercentageRate

    Schema: PercentageRate

  • amountAmountType

    Schema: AmountType

ISO20022object

TaxInformation

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 (11)

  • creditorTaxParty

    Schema: TaxParty

  • debtorTaxParty

    Schema: TaxParty

  • ultimateDebtorTaxParty

    Schema: TaxParty

  • administrationZonestring

    Territorial part of a country to which the tax payment is related.

    Constraints: maxLength: 35

  • referenceNumberstring

    Tax reference information that is specific to a taxing agency.

    Constraints: maxLength: 140

  • methodstring

    Method used to indicate the underlying business or how the tax is paid.

    Constraints: maxLength: 35

  • totalTaxableBaseAmountAmountType

    Schema: AmountType

  • totalTaxAmountAmountType

    Schema: AmountType

  • datestring (date)

    Date by which tax is due.

  • sequenceNumberinteger (int32)

    Sequential number of the tax report.

  • recordarray<TaxRecord>

    Records of tax details

    Item schema: TaxRecord

ISO20022object

TaxParty

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 (4)

  • taxIdentificationstring

    Tax identification number of the party.

    Constraints: maxLength: 35

  • registrationIdentificationstring

    Unique identification, as assigned by an organisation, to unambiguously identify a party.

    Constraints: maxLength: 35

  • taxTypestring

    Type of tax payer.

    Constraints: maxLength: 35

  • authorisationTitleAndName

    Schema: TitleAndName

ISO20022object

TaxPeriod

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 (4)

  • yearstring

    Year related to the tax payment.

    Constraints: pattern: `^[0-9]{4,4}$`

  • typeTaxRecordPeriodCode

    Schema: TaxRecordPeriodCode

  • fromDatestring (date)

    Start date of the range.

  • toDatestring (date)

    End date of the range.

ISO20022object

TaxRecord

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 (9)

  • typestring

    High level code to identify the type of tax details.

    Constraints: maxLength: 35

  • categorystring

    Specifies the tax code as published by the tax authority.

    Constraints: maxLength: 35

  • categoryDetailsstring

    Provides further details of the category tax code.

    Constraints: maxLength: 35

  • debtorStatusstring

    Code provided by local authority to identify the status of the party that has drawn up the settlement document.

    Constraints: maxLength: 35

  • certificateIdentificationstring

    Identification number of the tax report as assigned by the taxing authority.

    Constraints: maxLength: 35

  • formsCodestring

    Identifies, in a coded form, on which template the tax report is to be provided.

    Constraints: maxLength: 35

  • periodTaxPeriod

    Schema: TaxPeriod

  • taxAmountTaxAmount

    Schema: TaxAmount

  • additionalInformationstring

    Further details of the tax record.

    Constraints: maxLength: 140

ISO20022object

TaxRecordDetails

ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values.

PropertyDescription
periodSet of elements used to provide details on the period of time related to the tax payment.
amountUnderlying tax amount related to the specified period.

Fields (2)

ISO20022string

TaxRecordPeriodCode

Identification of the period related to the tax payment.

CodeNameDescription
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.—
ISO20022object

TitleAndName

Title and Name of the party or the party's authorised reprensentative.

Fields (2)

  • titlestring

    Title or position of the party or the party's authorised reprensentative.

    Constraints: maxLength: 35

  • namestring

    Name of the party or the party's authorised reprensentative.

    Constraints: maxLength: 140

ISO20022object

TransactionResource

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 (21)

  • resourceIdResourceId

    Schema: ResourceId

  • entryReferencestring

    Technical incremental identification of the transaction used for reconciliation by the AISP.

    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

  • transactionAmountAmountTyperequired

    Schema: AmountType

  • creditDebitIndicatorCreditDebitIndicatorrequired

    Schema: CreditDebitIndicator

  • transactionAmountDetailsAmountAndCurrencyExchange

    Schema: AmountAndCurrencyExchange

  • statusTransactionStatusrequired

    Schema: TransactionStatus

  • endToEndIdEndToEndId

    Schema: EndToEndId

  • expectedBookingDatestring (date-time)

    Expected booking date of the transaction on the account if the transaction is not yet booked.

    Expected booking date of the transaction on the account if the transaction is not yet booked.

  • bookingDatestring (date-time)

    Real booking date of the transaction on the account

    Real booking date of the transaction on the account

  • valueDatestring (date-time)

    Value date of the transaction on the account

  • transactionDatestring (date-time)

    Date used for specific purposes:

    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
  • bankTransactionCodeBankTransactionCode

    Schema: BankTransactionCode

  • chargesCharges

    Schema: Charges

  • relatedPartiesRelatedParties

    Schema: RelatedParties

  • remittanceInformationRemittanceInformation

    Schema: RemittanceInformation

  • additionalTransactionInformationstring

    Additional information about reconciliation.

    Constraints: maxLength: 500

  • standingOrderCharacteristicsStandingOrderCharacteristics

    Schema: StandingOrderCharacteristics

  • merchantCategoryCodestring

    Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

    Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

    Constraints: maxLength: 4

  • bookingPeriodPeriod

    Schema: Period

  • cardIdGenericIdentification

    Schema: GenericIdentification

ISO20022string

TransactionStatus

Type of Transaction

CodeNameDescription
BOOK
ClosingBookedAccounted transaction
PDNG
PendingTransaction that is to be accounted and does already affect the instant balance
FUTR
FutureEntry is on the books of the account servicer and value will be applied to the account owner at a future date and time.
INFO
InformationEntry is only provided for information, and no booking on the account owner's account in the account servicer's ledger was performed.
ISO20022object

TypedAmount

ISO20022: Typed Amount API: Amounts must always be set as positive values.

Fields (2)

  • typestring

    Type of the amount

    Constraints: maxLength: 35

  • amountAmountTyperequired

    Schema: AmountType