{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/groupe-bpce/main/json-schema/groupe-bpce-hal-transactions-schema.json",
  "title": "HalTransactions",
  "description": "HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/groupe-bpce-psd2-accounts-openapi.yml#/components/schemas/HalTransactions",
  "type": "object",
  "properties": {
    "transactions": {
      "description": "List of transactions",
      "type": "array",
      "items": {
        "$ref": "#/$defs/TransactionResource"
      }
    },
    "_links": {
      "$ref": "#/$defs/TransactionsLinks"
    }
  },
  "required": [
    "transactions",
    "_links"
  ],
  "$defs": {
    "AccountIdentification": {
      "description": "Unique and unambiguous identification for the account between the account owner and the account servicer.\nCard accounts must provide the identification of the card through the \"other\" substructure by giving, for instance, the masked PAN (MPAN).\nThe currency used for the account, when needed, can be specified through the [currency] field.\n",
      "type": "object",
      "properties": {
        "workspace": {
          "description": "Workspace to which the account is linked.\nThis workspace might be specified by the AISP when forwarding the consent on accounts.\nIf not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.\n",
          "type": "string",
          "maxLength": 32
        },
        "iban": {
          "description": "ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.\n\nFurther 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.\n",
          "type": "string",
          "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$"
        },
        "other": {
          "$ref": "#/$defs/GenericIdentification"
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        }
      }
    },
    "AmountAndCurrencyExchange": {
      "description": "Provides detailed information on the original amount.\nThe [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.\nThe [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.\nThe [cunterValueAmount] property embbeds the set of elements used to provide the countervalue amount and currency exchange information.\n- 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.\nThe [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.\n- In some situations, this amount may alternatively be called entitled amount.\n",
      "type": "object",
      "properties": {
        "instructedAmount": {
          "$ref": "#/$defs/AmountAndCurrencyExchangeDetails"
        },
        "transactionAmount": {
          "$ref": "#/$defs/AmountAndCurrencyExchangeDetails"
        },
        "counterValueAmount": {
          "$ref": "#/$defs/AmountAndCurrencyExchangeDetails"
        },
        "announcedPostingAmount": {
          "$ref": "#/$defs/AmountAndCurrencyExchangeDetails"
        },
        "proprietaryAmount": {
          "description": "Set of elements used to provide information on the original amount and currency exchange.\n",
          "type": "array",
          "items": {
            "$ref": "#/$defs/AmountAndCurrencyExchangeDetails"
          }
        }
      }
    },
    "AmountAndCurrencyExchangeDetails": {
      "description": "ISO20022: details on amount and currency exchange\nThe [amount] property is the amount of money to be exchanged against another amount of money in the counter currency.\nThe [sourceCurency] property indicates the currency from which an amount is to be converted in a currency conversion.\nThe [targetCurrency] property indicates the currency into which an amount is to be converted in a currency conversion.\nThe [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.\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "type": {
          "description": "specifies the type of amount in case of proprietary amount",
          "type": "string",
          "maxLength": 35
        },
        "amount": {
          "$ref": "#/$defs/AmountType"
        },
        "sourceCurrency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "targetCurrency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "unitCurrency": {
          "$ref": "#/$defs/CurrencyCode"
        },
        "exchangeRate": {
          "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\nExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).\n",
          "type": "number",
          "format": "float"
        },
        "contractIdentification": {
          "description": "Unique identification to unambiguously identify the foreign exchange contract.",
          "type": "string",
          "maxLength": 35
        },
        "quotationDate": {
          "description": "Date and time at which an exchange rate is quoted.",
          "type": "string",
          "format": "date"
        }
      },
      "required": [
        "amount",
        "sourceCurrency",
        "exchangeRate"
      ]
    },
    "AmountType": {
      "description": "Structure aiming to embed the amount and the currency to be used.\n",
      "type": "object",
      "properties": {
        "amount": {
          "description": "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.\n",
          "type": "number",
          "format": "float",
          "pattern": "^\\-{0,1}[0-9]{1,13}(\\.[0-9]{0,5}){0,1}$"
        },
        "currency": {
          "$ref": "#/$defs/CurrencyCode"
        }
      },
      "required": [
        "amount",
        "currency"
      ]
    },
    "BankTransactionCode": {
      "description": "Set of elements used to fully identify the type of underlying transaction resulting in an entry.\n\nISO20022 provides a list of [possible Bank Transaction Code combinations](https://www.iso20022.org/external_code_list.page)\n\nTransaction codification might also be specified at national community level.\n\nFor instance a French Transaction codification is [available](https://www.cfonb.org/fichiers/20190913092943_Brochure_Codes_Operation_pour_restitutions_clienteles_V5_0_novembre_2018.pdf)\n\nIt applies with § 2 code table using the following mapping:\n  - domain must be set with \"FR\"\n  - family must be set with one of the values that are provided in the [code Famille] column (e.g. \"OPCA\")\n  - subFamily must be set with one of the values that are provided in the [code opération] column (e.g. \"05\")\n  - code might be set with a proprietary transaction code that must be documented by the implementation.\n",
      "type": "object",
      "properties": {
        "domain": {
          "description": "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.\n",
          "type": "string",
          "maxLength": 4
        },
        "family": {
          "description": "Specifies the family and the sub-family of the bank transaction code, within a specific domain, in a structured and hierarchical format.\n",
          "type": "string",
          "maxLength": 4
        },
        "subFamily": {
          "description": "Specifies the sub-product family within a specific family.\n",
          "type": "string",
          "maxLength": 4
        },
        "code": {
          "description": "Proprietary bank transaction code to identify the underlying transaction.\n",
          "type": "string",
          "maxLength": 35
        },
        "issuer": {
          "description": "Identification of the issuer of the proprietary bank transaction code.\n",
          "type": "string",
          "maxLength": 35
        }
      },
      "required": [
        "domain",
        "family",
        "subFamily"
      ]
    },
    "ChargeBearerCode": {
      "description": "ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.\nThe following values are allowed:\n| Code | Name | Description |\n| ---- | ---- | ---------- |\n| DEBT | BorneByDebtor | All transaction charges are to be borne by the debtor. |\n| CRED | BorneByCreditor | All transaction charges are to be borne by the creditor. |\n| 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. |\n| SLEV | FollowingServiceLevel | Charges are to be applied following the rules agreed in the service level and/or scheme. |\n",
      "type": "string",
      "enum": [
        "DEBT",
        "CRED",
        "SHAR",
        "SLEV"
      ]
    },
    "Charges": {
      "description": "ISO20022: Provides further details on the charges related to the payment transaction.\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "totalChargesAndTaxAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "record": {
          "description": "Provides details of the individual charges record.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/ChargesRecord"
          }
        }
      }
    },
    "ChargesRecord": {
      "description": "ISO20022: Provides further individual record details on the charges related to the payment transaction.\n- The [amount] proprty specifies the transaction charges to be paid by the charge bearer.\n- The [creditDebitIndicator] property indicates whether the charges amount is a credit or a debit amount.\n  A zero amount is considered to be a credit.\n- the [code] property is the charge type, in a coded form\n- the [rate] property is the rate used to calculate the amount of the charge or fee.\n- the [bearer] property specifies which party/parties will bear the charges associated with the processing of the payment transaction.\n- the [agent] property specifies the agent that takes the transaction charges or to which the transaction charges are due.\n- the [tax] property provides details on the tax applied to charges.\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "amount": {
          "$ref": "#/$defs/AmountType"
        },
        "creditDebitIndicator": {
          "$ref": "#/$defs/CreditDebitIndicator"
        },
        "chargeIncludedIndicator": {
          "description": "Indicates whether the charge should be included in the amount or is added as pre-advice.\nOne of the following values must be used:\n  - Meaning When True: Included\n  - Meaning When False: Pre-advised\n",
          "type": "boolean"
        },
        "code": {
          "$ref": "#/$defs/CodeAndIssuer"
        },
        "rate": {
          "$ref": "#/$defs/PercentageRate"
        },
        "bearer": {
          "$ref": "#/$defs/ChargeBearerCode"
        },
        "agent": {
          "$ref": "#/$defs/FinancialInstitutionIdentification"
        },
        "tax": {
          "$ref": "#/$defs/TaxCharges"
        }
      }
    },
    "ClearingSystemMemberIdentification": {
      "description": "ISO20022: Information used to identify a member within a clearing system.\nAPI: to be used for some specific international credit transfers in order to identify the beneficiary bank\n",
      "type": "object",
      "properties": {
        "clearingSystemId": {
          "description": "ISO20022: Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n",
          "type": "string",
          "maxLength": 35
        },
        "memberId": {
          "description": "ISO20022: Identification of a member of a clearing system.\n",
          "type": "string",
          "maxLength": 35
        }
      },
      "required": [
        "clearingSystemId",
        "memberId"
      ]
    },
    "CodeAndIssuer": {
      "description": "Specifies a code and the issuer of this code.\n",
      "type": "object",
      "properties": {
        "code": {
          "description": "Provides the code.",
          "type": "string",
          "maxLength": 4
        },
        "issuer": {
          "description": "Identification of the issuer of the code.",
          "type": "string",
          "maxLength": 35
        }
      },
      "required": [
        "code"
      ]
    },
    "ContactDetails": {
      "description": "Indicates how to contact the party.\n",
      "type": "object",
      "properties": {
        "phoneNumber": {
          "$ref": "#/$defs/PhoneNumber"
        },
        "faxNumber": {
          "$ref": "#/$defs/PhoneNumber"
        },
        "emailAddress": {
          "description": "email address of the contact",
          "type": "string",
          "pattern": "^.+@.+$",
          "maxLength": 2048
        }
      }
    },
    "CreditDebitIndicator": {
      "description": "Accounting flow of the amount\n| Code | Description |\n| ---- | ----------- |\n| CRDT | Credit type amount |\n| DBIT | Debit type amount |\n",
      "type": "string",
      "enum": [
        "CRDT",
        "DBIT"
      ]
    },
    "CreditorReferenceInformation": {
      "description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/CodeAndIssuer"
        },
        "reference": {
          "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
          "type": "string",
          "maxLength": 35
        }
      }
    },
    "CurrencyCode": {
      "description": "Specifies the currency of the amount or of the account.\nA 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\".\n",
      "type": "string",
      "pattern": "^[A-Z]{3,3}$"
    },
    "DateAndPlaceOfBirth": {
      "description": "Date and place of birth of a person.\nThis information must be requested for detection of Fraud, Money-Laundering and Terrorism Financing in case of international payment.\n",
      "type": "object",
      "properties": {
        "birthDate": {
          "description": "Date on which a person is born.",
          "type": "string",
          "format": "date"
        },
        "cityOfBirth": {
          "description": "City where a person was born.",
          "type": "string",
          "maxLength": 35
        },
        "countryOfBirth": {
          "description": "Country where a person was born.",
          "type": "string",
          "pattern": "^[A-Z]{2,2}$"
        }
      },
      "required": [
        "birthDate",
        "cityOfBirth",
        "countryOfBirth"
      ]
    },
    "DocumentAdjustment": {
      "description": "ISO20022: Specifies detailed information on the amount and reason of the adjustment.\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "amount": {
          "$ref": "#/$defs/AmountType"
        },
        "creditDebitIndicator": {
          "$ref": "#/$defs/CreditDebitIndicator"
        },
        "reason": {
          "description": "Specifies the reason for the adjustment.",
          "type": "string",
          "maxLength": 4
        },
        "additionalInformation": {
          "description": "Provides further details on the document adjustment.",
          "type": "string",
          "maxLength": 140
        }
      },
      "required": [
        "amount"
      ]
    },
    "DocumentLineIdentification": {
      "description": "Provides identification of the document line.\nthe [type] property must be used for specifying the type of referred document type.\n",
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/CodeAndIssuer"
        },
        "number": {
          "description": "Unique and unambiguous identification of the referred document line.",
          "type": "string",
          "maxLength": 35
        },
        "relatedDate": {
          "description": "Date associated with the referred document line.",
          "type": "string",
          "format": "date"
        }
      }
    },
    "EndDate": {
      "description": "The last applicable day of execution for a given period.\nIf not given, the period is considered as endless.\n",
      "type": "string",
      "format": "date-time"
    },
    "EndToEndId": {
      "description": "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.\n",
      "type": "string",
      "pattern": "^([a-zA-Z0-9 /\\-?:\\()\\.,']{1,36})$"
    },
    "ExecutionRule": {
      "description": "Execution date shifting rule for standing orders\nThis data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday.\nThe payment is then executed either the \"preceding\" or \"following\" working day.\nASPSP might reject the request due to the communicated value, if rules in Online-Banking are not supporting\nthis execution rule.\n| Code | Description |\n| ---- | ----------- |\n| FWNG | following |\n| PREC | preceding |\n",
      "type": "string",
      "enum": [
        "FWNG",
        "PREC"
      ]
    },
    "FinancialInstitutionIdentification": {
      "description": "ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n",
      "type": "object",
      "properties": {
        "bicFi": {
          "description": "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)\".\n",
          "type": "string",
          "pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$"
        },
        "clearingSystemMemberId": {
          "$ref": "#/$defs/ClearingSystemMemberIdentification"
        },
        "lei": {
          "$ref": "#/$defs/LeiIdentification"
        },
        "name": {
          "description": "Name of the financial institution",
          "type": "string",
          "maxLength": 140
        },
        "postalAddress": {
          "$ref": "#/$defs/PostalAddress"
        }
      },
      "required": [
        "bicFi"
      ]
    },
    "FrequencyCode": {
      "description": "Frequency rule for standing orders.\nThe following codes from the \"EventFrequency7Code\" of ISO 20022 are supported.\n| Code | Description |\n| ---- | ----------- |\n| DAIL | Daily |\n| WEEK | Weekly |\n| TOWK | EveryTwoWeeks |\n| MNTH | Monthly |\n| TOMN | EveryTwoMonths |\n| QUTR | Quarterly |\n| SEMI | SemiAnnual |\n| YEAR | Annual |\nHowever, each ASPSP might restrict these values into a subset if needed.\n",
      "type": "string",
      "enum": [
        "DAIL",
        "WEEK",
        "TOWK",
        "MNTH",
        "TOMN",
        "QUTR",
        "SEMI",
        "YEAR"
      ]
    },
    "GenericIdentification": {
      "description": "ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.\nAPI: The ASPSP will document which account reference type it will support.\n",
      "type": "object",
      "properties": {
        "identification": {
          "description": "API: Identifier\n",
          "type": "string",
          "maxLength": 70
        },
        "schemeName": {
          "description": "Name of the identification scheme.\nPossible values for the scheme name, partially based on ISO20022 external code list, are the following:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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. |\n| 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. |\n| COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) |\n| 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. |\n| 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. |\n| NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. |\nOther values are also permitted, for instance:\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| 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 |\n| CPAN | CardPan | Card PAN |\n| MPAN | MaskedPan | Card PAN where some digits were replaced for security reason |\n| 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 |\n| 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 |\nEach implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used\n",
          "type": "string",
          "maxLength": 70
        },
        "issuer": {
          "description": "ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties\n",
          "type": "string",
          "maxLength": 35
        }
      },
      "required": [
        "identification",
        "schemeName"
      ]
    },
    "GenericLink": {
      "description": "hypertext reference",
      "type": "object",
      "properties": {
        "href": {
          "description": "URI to be used. HREF stands for Hypertext REFerence.",
          "type": "string",
          "maxLength": 2000
        },
        "templated": {
          "description": "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.\nOtherwise, this property must be absent or set to false\ndefault value: false\n",
          "type": "boolean"
        }
      },
      "required": [
        "href"
      ]
    },
    "LeiIdentification": {
      "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\".\n",
      "type": "string",
      "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$"
    },
    "LineDetail": {
      "description": "Set of elements used to provide the content of the referred document line.",
      "type": "object",
      "properties": {
        "identification": {
          "$ref": "#/$defs/DocumentLineIdentification"
        },
        "description": {
          "description": "Description associated with the document line.",
          "type": "string",
          "maxLength": 2048
        },
        "amount": {
          "$ref": "#/$defs/RemittanceAmount"
        }
      }
    },
    "PartyIdentification": {
      "description": "API : Description of a Party which can be either a person or an organization.\n",
      "type": "object",
      "properties": {
        "name": {
          "description": "ISO20022: Name by which a party is known and which is usually used to identify that party.\nThe [organisationId] property allows the specification of an unique and unambiguous way to identify an organisation.\nThe [privateId] property allows the specification of an unique and unambiguous way to identify a person.\n",
          "type": "string",
          "maxLength": 140
        },
        "dateAndPlaceOfBirth": {
          "$ref": "#/$defs/DateAndPlaceOfBirth"
        },
        "postalAddress": {
          "$ref": "#/$defs/PostalAddress"
        },
        "contactDetails": {
          "$ref": "#/$defs/ContactDetails"
        },
        "organisationId": {
          "$ref": "#/$defs/GenericIdentification"
        },
        "privateId": {
          "$ref": "#/$defs/GenericIdentification"
        },
        "lei": {
          "$ref": "#/$defs/LeiIdentification"
        }
      },
      "required": [
        "name"
      ]
    },
    "PercentageRate": {
      "description": "Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.",
      "type": "number",
      "format": "float"
    },
    "Period": {
      "description": "definition of a time period",
      "type": "object",
      "properties": {
        "startDate": {
          "$ref": "#/$defs/StartDate"
        },
        "endDate": {
          "$ref": "#/$defs/EndDate"
        }
      }
    },
    "PhoneNumber": {
      "description": "The collection of information which identifies a specific phone or FAX number as defined by telecom services.\nIt 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).\n",
      "type": "string",
      "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$"
    },
    "PostalAddress": {
      "description": "ISO20022: Information that locates and identifies a specific address, as defined by postal services.\n",
      "type": "object",
      "properties": {
        "addressType": {
          "description": "ISO20022: Identifies the nature of the postal address.\nAPI: Cannot be used for SEPA payments. Proprietary codes can be specified and documented if needed.\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BIZZ | Business | Address is the business address |\n| DLVY | Delivery | Address is the address to which delivery is to take place |\n| MLTO | Mail To | Address is the  address to which mail is sent |\n| PBOX | PO Box | Address is is a postal office (PO) box |\n| ADDR | Postal | Address is the complete postal address |\n| HOME | Business | Address is the home address |\n",
          "type": "string",
          "enum": [
            "BIZZ",
            "DLVY",
            "MLTO",
            "PBOX",
            "ADDR",
            "HOME"
          ]
        },
        "department": {
          "description": "ISO20022: Identification of a division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 70
        },
        "subDepartment": {
          "description": "ISO20022: Identification of a sub-division of a large organisation or building.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 70
        },
        "streetName": {
          "description": "ISO20022: Name of a street or thoroughfare.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 70
        },
        "buildingNumber": {
          "description": "ISO20022: Number that identifies the position of a building on a street.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 16
        },
        "buildingName": {
          "description": "ISO20022: Name of the building or house.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 16
        },
        "postCode": {
          "description": "ISO20022: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 16
        },
        "townName": {
          "description": "ISO20022: Name of a built-up area, with defined boundaries, and a local government.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 35
        },
        "countrySubDivision": {
          "description": "ISO20022: Identifies a subdivision of a country such as state, region, county.\nAPI: Cannot be used for SEPA payments.\n",
          "type": "string",
          "maxLength": 35
        },
        "country": {
          "description": "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.\n",
          "type": "string",
          "pattern": "^([A-Z]{2,2})$"
        },
        "addressLine": {
          "description": "Unstructured address. The lines must embed zip code and town name.\nFor SEPA payments, only two address lines are allowed.\n",
          "type": "array",
          "items": {
            "description": "Address line",
            "type": "string",
            "maxLength": 70
          },
          "minItems": 1,
          "maxItems": 7
        }
      },
      "required": [
        "country"
      ]
    },
    "ReferredDocumentInformation": {
      "description": "Provides the identification and the content of the referred document.",
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/$defs/CodeAndIssuer"
        },
        "number": {
          "description": "Unique and unambiguous identification of the referred document.",
          "type": "string",
          "maxLength": 35
        },
        "relatedDate": {
          "description": "Date associated with the referred document.",
          "type": "string",
          "format": "date"
        },
        "lineDetails": {
          "description": "Sets of elements used to provide the content of the referred document line.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/LineDetail"
          },
          "minItems": 1
        }
      }
    },
    "ReferredDocumentInformations": {
      "description": "Provides the identification and the content of the referred documents.\n",
      "type": "array",
      "items": {
        "$ref": "#/$defs/ReferredDocumentInformation"
      },
      "minItems": 1
    },
    "RelatedParties": {
      "description": "information about the parties that are related to the transaction",
      "type": "object",
      "properties": {
        "initiatingParty": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "debtorAgent": {
          "$ref": "#/$defs/FinancialInstitutionIdentification"
        },
        "debtor": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "debtorAccount": {
          "$ref": "#/$defs/AccountIdentification"
        },
        "ultimateDebtor": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "creditorAgent": {
          "$ref": "#/$defs/FinancialInstitutionIdentification"
        },
        "creditor": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "creditorAccount": {
          "$ref": "#/$defs/AccountIdentification"
        },
        "ultimateCreditor": {
          "$ref": "#/$defs/PartyIdentification"
        }
      }
    },
    "RemittanceAmount": {
      "description": "ISO20022: Provides details on the amounts of the document line.\nAPI: Amounts must always be set as positive values.\n| Property | Description |\n| -------- | ----------- |\n| duePayableAmount | Amount specified is the exact amount due and payable to the creditor. |\n| discountAppliedAmount | Amount of discount to be applied to the amount due and payable to the creditor. |\n| creditNoteAmount | Amount of a credit note. |\n| taxAmount | Amount of the tax. |\n| adjustmentAmountAndReason | Specifies detailed information on the amount and reason of the adjustment. |\n| remittedAmount | Amount of money remitted. |\n",
      "type": "object",
      "properties": {
        "duePayableAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "discountAppliedAmount": {
          "$ref": "#/$defs/TypedAmount"
        },
        "creditNoteAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "taxAmount": {
          "$ref": "#/$defs/TypedAmount"
        },
        "adjustmentAmountAndReason": {
          "$ref": "#/$defs/DocumentAdjustment"
        },
        "remittedAmount": {
          "$ref": "#/$defs/AmountType"
        }
      }
    },
    "RemittanceInformation": {
      "description": "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.\nAPI:\n- Only one occurrence of the unstructured information is allowed.\n- Only one occurrence of the structured information is allowed.\n- Structured and unstructured information can coexist.\n",
      "type": "object",
      "properties": {
        "unstructured": {
          "description": "Unstructured remittance information.\nEach implementation may add a pattern in order to specify its own character set constraints. \n",
          "type": "array",
          "items": {
            "title": "remittanceLine",
            "description": "Relevant information to the transaction",
            "type": "string",
            "maxLength": 140
          },
          "minItems": 1
        },
        "structured": {
          "description": "Structured remittance information",
          "type": "array",
          "items": {
            "$ref": "#/$defs/StructuredRemittanceInformation"
          },
          "minItems": 1
        }
      }
    },
    "ResourceId": {
      "description": "API: Identifier assigned by the ASPSP for further use of the created resource through API calls.\nThe API client cannot set or modify the value of this field.\nSince 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.\nHowever it is the duty of each ASPSP to perform its own risk analysis on this topic.\n",
      "type": "string",
      "pattern": "^([a-zA-Z0-9_ /\\-?:\\()\\.,']{1,100})$",
      "readOnly": true
    },
    "StandingOrderCharacteristics": {
      "description": "Specifies the characteristics of a standing order.\n",
      "type": "object",
      "properties": {
        "startDate": {
          "$ref": "#/$defs/StartDate"
        },
        "endDate": {
          "$ref": "#/$defs/EndDate"
        },
        "executionRule": {
          "$ref": "#/$defs/ExecutionRule"
        },
        "frequency": {
          "$ref": "#/$defs/FrequencyCode"
        }
      },
      "required": [
        "startDate",
        "executionRule",
        "frequency"
      ]
    },
    "StartDate": {
      "description": "The first applicable day of execution for a given period.\n",
      "type": "string",
      "format": "date-time"
    },
    "StructuredRemittanceInformation": {
      "description": "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.\n",
      "type": "object",
      "properties": {
        "referredDocumentInformation": {
          "$ref": "#/$defs/ReferredDocumentInformations"
        },
        "referredDocumentAmount": {
          "$ref": "#/$defs/RemittanceAmount"
        },
        "creditorReferenceInformation": {
          "$ref": "#/$defs/CreditorReferenceInformation"
        },
        "invoicer": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "invoicee": {
          "$ref": "#/$defs/PartyIdentification"
        },
        "taxRemittance": {
          "$ref": "#/$defs/TaxInformation"
        }
      }
    },
    "TaxAmount": {
      "description": "ISO20022: Set of elements used to provide information on the amount of the tax record.\nAPI: Amounts must always be set as positive values.\n| Property | Description |\n| -------- | ----------- |\n| rate | Rate used to calculate the tax. |\n| taxableBaseAmount | Amount of money on which the tax is based. |\n| totalAmount | Total amount that is the result of the calculation of the tax for the record. |\n| details | Set of elements used to provide details on the tax period and amount. |\n",
      "type": "object",
      "properties": {
        "rate": {
          "$ref": "#/$defs/PercentageRate"
        },
        "taxableBaseAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "totalAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "details": {
          "description": "Set of elements used to provide details on the tax period and amount.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaxRecordDetails"
          },
          "minItems": 1
        }
      }
    },
    "TaxCharges": {
      "description": "ISO20022: Provides details on the tax applied to charges.\n- The [rate] property is the rate used to calculate the tax.\n- the [amount] property is the amount of money resulting from the calculation of the tax.\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "identification": {
          "description": "Unique reference to unambiguously identify the nature of the tax levied, such as Value Added Tax (VAT).",
          "type": "string",
          "maxLength": 35
        },
        "rate": {
          "$ref": "#/$defs/PercentageRate"
        },
        "amount": {
          "$ref": "#/$defs/AmountType"
        }
      }
    },
    "TaxInformation": {
      "description": "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.\nAPI: Amounts must always be set as positive values.\nThe [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based.\nThe [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax.\n",
      "type": "object",
      "properties": {
        "creditor": {
          "$ref": "#/$defs/TaxParty"
        },
        "debtor": {
          "$ref": "#/$defs/TaxParty"
        },
        "ultimateDebtor": {
          "$ref": "#/$defs/TaxParty"
        },
        "administrationZone": {
          "description": "Territorial part of a country to which the tax payment is related.",
          "type": "string",
          "maxLength": 35
        },
        "referenceNumber": {
          "description": "Tax reference information that is specific to a taxing agency.",
          "type": "string",
          "maxLength": 140
        },
        "method": {
          "description": "Method used to indicate the underlying business or how the tax is paid.",
          "type": "string",
          "maxLength": 35
        },
        "totalTaxableBaseAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "totalTaxAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "date": {
          "description": "Date by which tax is due.",
          "type": "string",
          "format": "date"
        },
        "sequenceNumber": {
          "description": "Sequential number of the tax report.",
          "type": "integer",
          "format": "int32"
        },
        "record": {
          "description": "Records of tax details",
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaxRecord"
          },
          "minItems": 1
        }
      }
    },
    "TaxParty": {
      "description": "Set of elements used to identify a party of the transaction to which the tax applies.\nThe [authorization] property aims to provide the details of the authorised tax paying party.\n",
      "type": "object",
      "properties": {
        "taxIdentification": {
          "description": "Tax identification number of the party.",
          "type": "string",
          "maxLength": 35
        },
        "registrationIdentification": {
          "description": "Unique identification, as assigned by an organisation, to unambiguously identify a party.",
          "type": "string",
          "maxLength": 35
        },
        "taxType": {
          "description": "Type of tax payer.",
          "type": "string",
          "maxLength": 35
        },
        "authorisation": {
          "$ref": "#/$defs/TitleAndName"
        }
      }
    },
    "TaxPeriod": {
      "description": "Set of elements used to provide details on the period of time related to the tax payment.\nThe [type] property aims to identify the period related to the tax payment.\n",
      "type": "object",
      "properties": {
        "year": {
          "description": "Year related to the tax payment.",
          "type": "string",
          "pattern": "^[0-9]{4,4}$"
        },
        "type": {
          "$ref": "#/$defs/TaxRecordPeriodCode"
        },
        "fromDate": {
          "description": "Start date of the range.",
          "type": "string",
          "format": "date"
        },
        "toDate": {
          "description": "End date of the range.",
          "type": "string",
          "format": "date"
        }
      }
    },
    "TaxRecord": {
      "description": "Record of tax details\nthe [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment.\nthe [amount] property embbeds the set of elements used to provide information on the amount of the tax record.\n",
      "type": "object",
      "properties": {
        "type": {
          "description": "High level code to identify the type of tax details.",
          "type": "string",
          "maxLength": 35
        },
        "category": {
          "description": "Specifies the tax code as published by the tax authority.",
          "type": "string",
          "maxLength": 35
        },
        "categoryDetails": {
          "description": "Provides further details of the category tax code.",
          "type": "string",
          "maxLength": 35
        },
        "debtorStatus": {
          "description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
          "type": "string",
          "maxLength": 35
        },
        "certificateIdentification": {
          "description": "Identification number of the tax report as assigned by the taxing authority.",
          "type": "string",
          "maxLength": 35
        },
        "formsCode": {
          "description": "Identifies, in a coded form, on which template the tax report is to be provided.",
          "type": "string",
          "maxLength": 35
        },
        "period": {
          "$ref": "#/$defs/TaxPeriod"
        },
        "taxAmount": {
          "$ref": "#/$defs/TaxAmount"
        },
        "additionalInformation": {
          "description": "Further details of the tax record.",
          "type": "string",
          "maxLength": 140
        }
      }
    },
    "TaxRecordDetails": {
      "description": "ISO20022: Elements used to provide details on the tax period and amount.\nAPI: Amounts must always be set as positive values.\n| Property | Description |\n| -------- | ----------- |\n| period | Set of elements used to provide details on the period of time related to the tax payment. |\n| amount | Underlying tax amount related to the specified period. |\n",
      "type": "object",
      "properties": {
        "period": {
          "$ref": "#/$defs/TaxPeriod"
        },
        "amount": {
          "$ref": "#/$defs/AmountType"
        }
      },
      "required": [
        "amount"
      ]
    },
    "TaxRecordPeriodCode": {
      "description": "Identification of the period related to the tax payment.\n| Code | Description |\n| ---- | ---------- |\n| MM01 | FirstMonth Tax is related to the second month of the period. |\n| MM02 | SecondMonth Tax is related to the first month of the period. |\n| MM03 | ThirdMonth Tax is related to the third month of the  period. |\n| MM04 | FourthMonth Tax is related to the fourth month of the period. |\n| MM05 | FifthMonth Tax is related to the fifth month of the period. |\n| MM06 | SixthMonth Tax is related to the sixth month of the period. |\n| MM07 | SeventhMonth Tax is related to the seventh month of the period. |\n| MM08 | EighthMonth Tax is related to the eighth month of the period. |\n| MM09 | NinthMonth Tax is related to the ninth month of the period. |\n| MM10 | TenthMonth Tax is related to the tenth month of the period. |\n| MM11 | EleventhMonth Tax is related to the eleventh month of the period. |\n| MM12 | TwelfthMonth Tax is related to the twelfth month of the period. |\n| QTR1 | FirstQuarter Tax is related to the first quarter of the period. |\n| QTR2 | SecondQuarter Tax is related to the second quarter of the period. |\n| QTR3 | ThirdQuarter Tax is related to the third quarter of the period. |\n| QTR4 | FourthQuarter Tax is related to the fourth quarter of the period. |\n| HLF1 | FirstHalf Tax is related to the first half of the period. |\n| HLF2 | SecondHalf Tax is related to the second half of the period. |\n",
      "type": "string",
      "enum": [
        "MM01",
        "MM02",
        "MM03",
        "MM04",
        "MM05",
        "MM06",
        "MM07",
        "MM08",
        "MM09",
        "MM10",
        "MM11",
        "MM12",
        "QTR1",
        "QTR2",
        "QTR3",
        "QTR4",
        "HLF1",
        "HLF2"
      ]
    },
    "TitleAndName": {
      "description": "Title and Name of the party or the party's authorised reprensentative.",
      "type": "object",
      "properties": {
        "title": {
          "description": "Title or position of the party or the party's authorised reprensentative.",
          "type": "string",
          "maxLength": 35
        },
        "name": {
          "description": "Name of the party or the party's authorised reprensentative.",
          "type": "string",
          "maxLength": 140
        }
      }
    },
    "TransactionLinks": {
      "description": "links that can be used for further retrieving details on a given transaction\n| Link | Description |\n| ---- | ----------- |\n| details | link to the details of the transaction |\n",
      "type": "object",
      "properties": {
        "details": {
          "$ref": "#/$defs/GenericLink"
        }
      },
      "readOnly": true
    },
    "TransactionResource": {
      "description": "ISO20022: Structure of a transaction.\n- the [charges] property provides information on the charges, pre-advised or included in the entry amount.\n- the [relatedParties] property specifies either the debtor or the creditor counterpart information\nAPI:\n- Amounts must always be set as positive values in complement with the Credit/Debit indicator.\n- At least expectedBookingDate or bookingDate must be provided\"\n",
      "type": "object",
      "properties": {
        "resourceId": {
          "$ref": "#/$defs/ResourceId"
        },
        "entryReference": {
          "description": "Technical incremental identification of the transaction used for reconciliation by the AISP.\nOnce assigned, this value cannot be changed for the relevant transaction.\nIt is assumed that this value is unique and thus cannot be shared by several transactions.\n\nThe reconciliation of transactions can be done by the [resourceId] or the [entryReference] field.\nIf none of these fields cannot be provided, it is therefore suggested that the [remittanceInformation] field, once set, should not be updated afterwards.  \nActually the [additionalTransactionInformation] field can be used to update the details of a given transaction.   \n",
          "type": "string",
          "maxLength": 40
        },
        "transactionAmount": {
          "$ref": "#/$defs/AmountType"
        },
        "creditDebitIndicator": {
          "$ref": "#/$defs/CreditDebitIndicator"
        },
        "transactionAmountDetails": {
          "$ref": "#/$defs/AmountAndCurrencyExchange"
        },
        "status": {
          "$ref": "#/$defs/TransactionStatus"
        },
        "endToEndId": {
          "$ref": "#/$defs/EndToEndId"
        },
        "expectedBookingDate": {
          "description": "Expected booking date of the transaction on the account if the transaction is not yet booked.\n",
          "type": "string",
          "format": "date-time"
        },
        "bookingDate": {
          "description": "Real booking date of the transaction on the account\n",
          "type": "string",
          "format": "date-time"
        },
        "valueDate": {
          "description": "Value date of the transaction on the account",
          "type": "string",
          "format": "date-time"
        },
        "transactionDate": {
          "description": "Date used for specific purposes:\n- for card transaction: date of the commercial transaction\n- for credit transfer: acquiring date of the transaction as seen by the Payer's Bank\n- for direct debit: receiving date of the transaction as seen by the Payer's Bank\n",
          "type": "string",
          "format": "date-time"
        },
        "bankTransactionCode": {
          "$ref": "#/$defs/BankTransactionCode"
        },
        "charges": {
          "$ref": "#/$defs/Charges"
        },
        "relatedParties": {
          "$ref": "#/$defs/RelatedParties"
        },
        "remittanceInformation": {
          "$ref": "#/$defs/RemittanceInformation"
        },
        "additionalTransactionInformation": {
          "description": "Additional information about reconciliation.",
          "type": "string",
          "maxLength": 500
        },
        "standingOrderCharacteristics": {
          "$ref": "#/$defs/StandingOrderCharacteristics"
        },
        "merchantCategoryCode": {
          "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.\n",
          "type": "string",
          "maxLength": 4
        },
        "_links": {
          "$ref": "#/$defs/TransactionLinks"
        },
        "bookingPeriod": {
          "$ref": "#/$defs/Period"
        },
        "cardId": {
          "$ref": "#/$defs/GenericIdentification"
        }
      },
      "required": [
        "transactionAmount",
        "status",
        "creditDebitIndicator"
      ]
    },
    "TransactionStatus": {
      "description": "Type of Transaction\n| Code | Name | Description |\n| ---- | ---- | ----------- |\n| BOOK | ClosingBooked | Accounted transaction |\n| PDNG | Pending | Transaction that is to be accounted and does already affect the instant balance |\n| 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. |\n| 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. |\n",
      "type": "string",
      "enum": [
        "BOOK",
        "PDNG",
        "FUTR",
        "INFO"
      ]
    },
    "TransactionsLinks": {
      "description": "links that can be used for further navigation when browsing transactions Information at one account level\n| Link | Description |\n| ---- | ----------- |\n| self | link to the transactions of a given account |\n| parent-list | link to the list of all available accounts |\n| owners | link to the owners identities for a given account |\n| balances | link to the balances of a given account |\n| overdrafts | link to the lists of overdrafts of a given account |\n| first | link to the first page of the transactions result |\n| last | link to the last page of the transactions result |\n| next | link to the next page of the transactions result |\n| prev | link to the previous page of the transactions result |\n",
      "type": "object",
      "properties": {
        "self": {
          "$ref": "#/$defs/GenericLink"
        },
        "parent-list": {
          "$ref": "#/$defs/GenericLink"
        },
        "owners": {
          "$ref": "#/$defs/GenericLink"
        },
        "balances": {
          "$ref": "#/$defs/GenericLink"
        },
        "overdrafts": {
          "$ref": "#/$defs/GenericLink"
        },
        "first": {
          "$ref": "#/$defs/GenericLink"
        },
        "last": {
          "$ref": "#/$defs/GenericLink"
        },
        "next": {
          "$ref": "#/$defs/GenericLink"
        },
        "prev": {
          "$ref": "#/$defs/GenericLink"
        }
      },
      "required": [
        "self"
      ],
      "readOnly": true
    },
    "TypedAmount": {
      "description": "ISO20022: Typed Amount\nAPI: Amounts must always be set as positive values.\n",
      "type": "object",
      "properties": {
        "type": {
          "description": "Type of the amount",
          "type": "string",
          "maxLength": 35
        },
        "amount": {
          "$ref": "#/$defs/AmountType"
        }
      },
      "required": [
        "amount"
      ]
    }
  }
}