{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-mandate-initiation-request-schema.json",
  "title": "MandateInitiationRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-emandateservices-api-openapi.yml#/components/schemas/MandateInitiationRequest",
  "type": "object",
  "required": [
    "mandate_initiation_request"
  ],
  "properties": {
    "mandate_initiation_request": {
      "type": "object",
      "description": "The MandateInitiationRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor. The MandateInitiationRequest message is forwarded by the agent of the initiator to the agent of the counterparty. The MandateInitiationRequest message is used to setup the instruction that allows the debtor agent to accept instructions from the creditor, through the creditor agent, to debit the account of the debtor.",
      "allOf": [
        {
          "$ref": "#/$defs/MandateInitiationRequestV06"
        }
      ]
    }
  },
  "$defs": {
    "AccountIdentification4Choice": {
      "type": "object",
      "required": [
        "Othr",
        "iban"
      ],
      "properties": {
        "iban": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/IBAN2007Identifier"
            }
          ]
        },
        "Othr": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/GenericAccountIdentification1"
            }
          ]
        }
      },
      "description": "Unique and unambiguous identification for the account between the account owner and the account servicer. Either iban or Othr field value should be passed on request."
    },
    "AccountSchemeName1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "string",
          "description": "Proprietary Details",
          "minLength": 1,
          "maxLength": 35
        }
      },
      "description": "Name of the identification scheme. Either from Code or Proprietary is Required"
    },
    "ActiveCurrencyAndAmount": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "string",
          "description": "The number of fractional digits (or minor unit of currency) must comply with ISO 4217. Note: The decimal separator is a dot. Total18 digits allowed with up to 5 decimal places."
        },
        "currency": {
          "type": "string",
          "description": "Currency for the amount. Passed as Tag Attribute.",
          "pattern": "[A-Z]{3,3}"
        }
      }
    },
    "ActiveOrHistoricCurrencyCode": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "description": "Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.",
          "pattern": "[A-Z]{3,3}"
        }
      },
      "description": "Identification of the currency in which the account is held."
    },
    "AddressType2Code": {
      "type": "string",
      "description": "<br><br><b>ADDR</b>: Address is the complete postal address. <br><br><b>PBOX</b>: Address is a postal office (PO) box. <br><br><b>HOME</b>: Address is the home address. <br><br><b>BIZZ</b>: Address is the business address.<br><br><b>MLTO</b>: Address is the address to which mail is sent.<br><br><b>DLVY</b>: Address is the address to which delivery is to take place.",
      "enum": [
        "ADDR",
        "PBOX",
        "HOME",
        "BIZZ",
        "MLTO",
        "DLVY"
      ]
    },
    "AddressType3Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the type of address.<br><br><b>ADDR</b>: Address is the complete postal address. <br><br><b>PBOX</b>: Address is a postal office (PO) box. <br><br><b>HOME</b>: Address is the home address. <br><br><b>BIZZ</b>: Address is the business address.<br><br><b>MLTO</b>: Address is the address to which mail is sent.<br><br><b>DLVY</b>: Address is the address to which delivery is to take place.",
          "allOf": [
            {
              "$ref": "#/$defs/AddressType2Code"
            }
          ]
        },
        "proprietary": {
          "type": "object",
          "description": "Information related to an identification, for example, party identification or account identification.",
          "allOf": [
            {
              "$ref": "#/$defs/GenericIdentification30"
            }
          ]
        }
      },
      "description": "Either from Code or Proprietary is required."
    },
    "AnyBICDec2014Identifier": {
      "type": "string",
      "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"
    },
    "AuthenticationChannel1Choice": {
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the transaction authentication channel, as published in an external authentication channel code set.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "string",
          "description": "Proprietary Details",
          "minLength": 1,
          "maxLength": 35
        }
      },
      "description": "Channel used to transmit the authentication information. Either of Code or Proprietary is Required."
    },
    "Authorisation1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the level of approval depending on a number of factors, including payment type, threshold amount or local country or operations practice.<br><br><b>AUTH</b>: Indicates a file has been pre-authorized or approved within the originating customer environment and no further approval is required. <br><br><b>FDET</b>: Indicates that a file requires additional file level approval, with the ability to view both the payment information block and supporting customer credit transaction detail. <br><br><b>FSUM</b>: Indicates that a file requires additional file level approval, with the ability to view only the payment information block level information.<br><br><b>ILEV</b>: Indicates that a file requires all customer transactions to be authorized or approved.",
          "allOf": [
            {
              "$ref": "#/$defs/Authorisation1Code"
            }
          ]
        },
        "proprietary": {
          "type": "string",
          "description": "Specifies the proprietary description",
          "minLength": 1,
          "maxLength": 128
        }
      },
      "description": "Either of Code or Proprietary is required."
    },
    "Authorisation1Code": {
      "type": "string",
      "description": "<br><br><b>AUTH</b>: Indicates a file has been pre authorized or approved within the originating customer environment and no further approval is required. <br><br><b>FDET</b>: Indicates that a file requires additional file-level approval, with the ability to view both the payment information block and supporting customer credit transaction detail. <br><br><b>FSUM</b>: Indicates that a file requires additional file level approval, with the ability to view only the payment information block level information. <br><br><b>ILEV</b>: Indicates that a file requires all customer transactions to be authorized or approved.",
      "enum": [
        "AUTH",
        "FDET",
        "FSUM",
        "ILEV"
      ]
    },
    "BICFIDec2014Identifier": {
      "type": "string",
      "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"
    },
    "BranchAndFinancialInstitutionIdentification6": {
      "type": "object",
      "required": [
        "FinInstnId"
      ],
      "properties": {
        "branch_identification": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/BranchData3"
            }
          ]
        },
        "FinInstnId": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/FinancialInstitutionIdentification18"
            }
          ]
        }
      }
    },
    "BranchData3": {
      "type": "object",
      "properties": {
        "identification": {
          "type": "object",
          "description": "Unique and unambiguous identification of a branch of a financial institution.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "legal_entity": {
          "type": "object",
          "description": "Legal entity identification for the branch of the financial institution.",
          "allOf": [
            {
              "$ref": "#/$defs/LEIIdentifier"
            }
          ]
        },
        "name": {
          "type": "object",
          "description": "Name by which an agent is known and which is usually used to identify that agent.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "postal_address": {
          "type": "object",
          "description": "Information that locates and identifies a specific address, as defined by postal services.",
          "allOf": [
            {
              "$ref": "#/$defs/PostalAddress24"
            }
          ]
        }
      },
      "description": "Identifies a specific branch of a financial institution."
    },
    "CashAccount38": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "object",
          "description": "Identification of the currency in which the account is held.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
            }
          ]
        },
        "Id": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/AccountIdentification4Choice"
            }
          ]
        },
        "name": {
          "type": "object",
          "description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "type": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccountType2Choice"
            }
          ]
        },
        "proxy": {
          "type": "object",
          "description": "Specifies an alternate assumed name for the identification of the account.",
          "properties": {
            "type": {
              "type": "object",
              "description": "Type of the proxy identification. Either of Code or Proprietary is required.",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Specifies the external proxy account type code, as published in the proxy account type external code set.",
                  "minLength": 1,
                  "maxLength": 4
                },
                "proprietary": {
                  "type": "string",
                  "description": "Proprietary details",
                  "minLength": 1,
                  "maxLength": 35
                }
              }
            },
            "identification": {
              "type": "string",
              "description": "Identification used to indicate the account identification under another specified name.",
              "minLength": 1,
              "maxLength": 2048
            }
          },
          "required": [
            "identification"
          ]
        }
      }
    },
    "CashAccountType2Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "string",
          "description": "proprietary details",
          "minLength": 1,
          "maxLength": 35
        }
      },
      "description": "Specifies the nature, or use of the account. Either from Code Or Proprietary is required."
    },
    "CategoryPurpose1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the category purpose, as published in an external category purpose code list.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "object",
          "description": "Category purpose, in a proprietary form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specifies the high level purpose of the mandate based on a set of pre-defined categories. Either Code or Proprietary field value should be passed in request."
    },
    "ClearingSystemMemberIdentification2": {
      "type": "object",
      "required": [
        "MmbId"
      ],
      "properties": {
        "clearing_system_identification": {
          "type": "object",
          "description": "Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.",
          "properties": {
            "code": {
              "type": "string",
              "description": "Identification of a clearing system, in a coded form as published in an external list.",
              "minLength": 1,
              "maxLength": 5
            },
            "proprietary": {
              "type": "object",
              "description": "Identification code for a clearing system, that has not yet been identified in the list of clearing systems.",
              "allOf": [
                {
                  "$ref": "#/$defs/Max35Text"
                }
              ]
            }
          }
        },
        "MmbId": {
          "type": "object",
          "description": "Identification of a member of a clearing system.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Information used to identify a member within a clearing system."
    },
    "Contact4": {
      "type": "object",
      "properties": {
        "name_prefix": {
          "type": "object",
          "description": "Specifies the terms used to formally address a person.<br><br><b>DOCT</b>: Title of the person is Doctor or Dr. <br><br><b>MIST</b>: Title of the person is Mister or Mr. <br><br><b>MISS</b>: Title of the person is Miss. <br><br><b>MADM</b>: Title of the person is Madam.<br><br><b>MIKS</b>: Title of the person is Gender Neutral.",
          "allOf": [
            {
              "$ref": "#/$defs/NamePrefix2Code"
            }
          ]
        },
        "name": {
          "type": "object",
          "description": "Name by which a party is known and which is usually used to identify that party.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "phone_number": {
          "type": "object",
          "description": "Collection of information that identifies a phone number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "mobile_number": {
          "type": "object",
          "description": "Collection of information that identifies a mobile phone number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "fax_number": {
          "type": "object",
          "description": "Collection of information that identifies a FAX number, as defined by telecom services.",
          "allOf": [
            {
              "$ref": "#/$defs/PhoneNumber"
            }
          ]
        },
        "email_address": {
          "type": "object",
          "description": "Address for electronic mail (e-mail).",
          "allOf": [
            {
              "$ref": "#/$defs/Max2048Text"
            }
          ]
        },
        "email_purpose": {
          "type": "object",
          "description": "Purpose for which an email address may be used.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "job_title": {
          "type": "object",
          "description": "Title of the function.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "responsibility": {
          "type": "object",
          "description": "Role of a person in an organisation.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "department": {
          "type": "object",
          "description": "Identification of a division of a large organization or building.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "other": {
          "type": "array",
          "description": "Contact details in another form.",
          "items": {
            "$ref": "#/$defs/OtherContact1"
          }
        },
        "contact_preferred_method": {
          "type": "object",
          "description": "Preferred method used to reach the contact.<br><br><b>LETT</b>: Preferred method used to reach the contact is per letter. <br><br><b>FAXX</b>: Preferred method used to reach the contact is per fax.<br><br><b>PHON</b>: Preferred method used to reach the contact is per phone. <br><br><b>MAIL</b>: Preferred method used to reach the contact is per Email .<br><br><b>CELL</b>: Preferred method used to reach the contact is per mobile or cell phone.",
          "allOf": [
            {
              "$ref": "#/$defs/PreferredContactMethod1Code"
            }
          ]
        }
      },
      "description": "Set of elements used to indicate how to contact the party."
    },
    "CountryCode": {
      "type": "string",
      "pattern": "[A-Z]{2,2}",
      "description": "Nation with its own government. The code is checked against thelist of country names obtained from the United Nations (ISO 3166, Alpha-2code)."
    },
    "DateAndPlaceOfBirth1": {
      "type": "object",
      "required": [
        "birth_date",
        "city_of_birth",
        "country_of_birth"
      ],
      "properties": {
        "birth_date": {
          "type": "object",
          "description": "Date on which a person is born allOf: - $ref: "
        },
        "province_of_birth": {
          "type": "object",
          "description": "Province where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "city_of_birth": {
          "type": "object",
          "description": "City where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "country_of_birth": {
          "type": "object",
          "description": "Country where a person was born.",
          "allOf": [
            {
              "$ref": "#/$defs/CountryCode"
            }
          ]
        }
      },
      "description": "Date and place of birth of a person."
    },
    "DatePeriodDetails1": {
      "type": "object",
      "required": [
        "from_date"
      ],
      "properties": {
        "from_date": {
          "type": "object",
          "description": "Start date of the range.",
          "allOf": [
            {
              "$ref": "#/$defs/ISODate"
            }
          ]
        },
        "to_date": {
          "type": "object",
          "description": "End date of the range.",
          "allOf": [
            {
              "$ref": "#/$defs/ISODate"
            }
          ]
        }
      },
      "description": "Length of time for which the mandate remains valid."
    },
    "DocumentType6Code": {
      "type": "string",
      "description": "Document type in a coded form.<br><br><b>MSIN</b>: Document is an invoice claiming payment for the supply of metered services, for example gas or electricity supplied to a fixed meter. <br><br><b>CNFA</b>: Document is a credit note for the final amount settled for a commercial transaction.<br><br><b>DNFA</b>: Document is a debit note for the final amount settled for a commercial transaction. <br><br><b>CINV</b>:   Document is an invoice.<br><br><b>CREN</b>: Document is a credit note. <br><br><b>DEBN</b>: Document is a debit note. <br><br><b>HIRI</b>: Document is an invoice for the hiring of human resources or renting goods or equipment. <br><br><b>SBIN</b>: Document is an invoice issued by the debtor. <br><br><b>SVGS</b>: Account used for savings. <br><br><b>CMCN</b>: Document is an agreement between the parties, stipulating the terms and conditions of the delivery of goods or services.<br><br><b>SOAC</b>: Document is a statement of the transactions posted to the debtor's account at the supplier. <br><br><b>DISP</b>: Document is a dispatch advice. <br><br><b>BOLD</b>: Document is a shipping notice. <br><br><b>VCHR</b>: Document is an electronic payment document. <br><br><b>AROI</b>: Document is a payment that applies to a specific source document. <br><br><b>TSUT</b>: Document is a transaction identifier as assigned by the Trade Services Utility.<br><br><b>PUOR</b>: Document is a purchase order.",
      "enum": [
        "MSIN",
        "CNFA",
        "DNFA",
        "CINV",
        "CREN",
        "DEBN",
        "HIRI",
        "SBIN",
        "CMCN",
        "SOAC",
        "DISP",
        "BOLD",
        "VCHR",
        "AROI",
        "TSUT",
        "PUOR"
      ]
    },
    "FinancialIdentificationSchemeName1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Name of the identification scheme, in a coded form as published in an external list.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "object",
          "description": "Name of the identification scheme, in a free text form.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Name of the identification scheme. Either Code or Proprietary field value should be passed on request."
    },
    "FinancialInstitutionIdentification18": {
      "type": "object",
      "properties": {
        "bicfi": {
          "type": "object",
          "description": "Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC).",
          "allOf": [
            {
              "$ref": "#/$defs/BICFIDec2014Identifier"
            }
          ]
        },
        "ClrSysMmbId": {
          "type": "object",
          "description": "Information used to identify a member within a clearing system.",
          "allOf": [
            {
              "$ref": "#/$defs/ClearingSystemMemberIdentification2"
            }
          ]
        },
        "legal_entity": {
          "type": "object",
          "description": "Legal entity identification for the branch of the financialinstitution.",
          "allOf": [
            {
              "$ref": "#/$defs/LEIIdentifier"
            }
          ]
        },
        "name": {
          "type": "object",
          "description": "Name by which an agent is known and which is usually used to identify that agent.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "postal_address": {
          "type": "object",
          "description": "Information that locates and identifies a specific address, as defined by postal services.",
          "allOf": [
            {
              "$ref": "#/$defs/PostalAddress24"
            }
          ]
        },
        "other": {
          "type": "object",
          "description": "Unique identification of an agent, as assigned by an institution, using an identification scheme.",
          "allOf": [
            {
              "$ref": "#/$defs/GenericFinancialIdentification1"
            }
          ]
        }
      }
    },
    "Frequency10Code": {
      "type": "string",
      "description": "Specifies the regularity of an event. NEVR - Event does never take place. YEAR - Event takes place every year or once a year. RATE - Event takes place based on a change of a rate. MIAN - Event takes place every six months or two times a year. QURT - Event takes place every three months or four times a year.",
      "enum": [
        "NEVR",
        "YEAR",
        "RATE",
        "MIAN",
        "QURT"
      ]
    },
    "Frequency36Choice": {
      "type": "object",
      "required": [
        "Prd",
        "point_in_time",
        "type"
      ],
      "properties": {
        "type": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/Frequency6Code"
            }
          ]
        },
        "Prd": {
          "type": "object",
          "description": "Defines a frequency in terms on counts per period for a specific period type.",
          "properties": {
            "type": {
              "type": "object",
              "description": "Period for which the number of instructions are to be created and processed.",
              "allOf": [
                {
                  "$ref": "#/$defs/Frequency6Code"
                }
              ]
            },
            "count_per_period": {
              "type": "string",
              "description": "Number of instructions to be created and processed during the specified period. Number of objects represented as a decimal number, for example 0.75 or 45.6. Fractional Digits up to 17 allowed.",
              "maxLength": 18
            }
          },
          "required": [
            "count_per_period",
            "type"
          ]
        },
        "point_in_time": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/FrequencyAndMoment1"
            }
          ]
        }
      },
      "description": "Regularity with which instructions are to be created and processed."
    },
    "Frequency37Choice": {
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the regularity of an event. NEVR - Event does never take place. YEAR - Event takes place every year or once a year. RATE -Event takes place based on a change of a rate. MIAN - Event takes place every six months or two times a year. QURT - Event takes place every three months or four times a year.",
          "allOf": [
            {
              "$ref": "#/$defs/Frequency10Code"
            }
          ]
        },
        "proprietary": {
          "type": "string",
          "description": "Proprietary Details"
        }
      },
      "description": "Defines the category of adjustment.Either from Code or Proprietaryis Required."
    },
    "Frequency6Code": {
      "type": "string",
      "description": "Specifies the regularity of an event.<br><br><b>YEAR</b>: Event takes place every year or once a year. <br><br><b>MNTH</b>: Event takes placeevery month or once a month. <br><br><b>QURT</b>: Event takes place everythree months or four times a year. <br><br><b>MIAN</b>: Event takes placeevery six months or two times a year.<br><br><b>WEEK</b>: Event takes place once a week. <br><br><b>DAIL</b>: Event takes place every day. <br><br><b>ADHO</b>: Event takes place on request or as necessary. <br><br><b>INDA</b>: Event takes place several times a day. <br><br><b>FRTN</b>: Event takes place every two weeks.",
      "enum": [
        "YEAR",
        "MNTH",
        "QURT",
        "MIAN",
        "WEEK",
        "DAIL",
        "ADHO",
        "INDA",
        "FRTN"
      ]
    },
    "FrequencyAndMoment1": {
      "type": "object",
      "required": [
        "point_in_time",
        "type"
      ],
      "properties": {
        "type": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/Frequency6Code"
            }
          ]
        },
        "point_in_time": {
          "type": "string",
          "description": "Further information on the exact point in time the event should take place.",
          "pattern": "[0-9]{2}"
        }
      },
      "description": "Defines a frequency in terms a specific moment within a specified period type."
    },
    "GenericAccountIdentification1": {
      "type": "object",
      "required": [
        "Id"
      ],
      "properties": {
        "Id": {
          "type": "object",
          "description": "Identification assigned by an institution.",
          "allOf": [
            {
              "$ref": "#/$defs/Max34Text"
            }
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Entity that assigns the identification.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "SchmeNm": {
          "type": "object",
          "description": "Name of the identification scheme.",
          "allOf": [
            {
              "$ref": "#/$defs/AccountSchemeName1Choice"
            }
          ]
        }
      },
      "description": "Information related to a generic account identification."
    },
    "GenericFinancialIdentification1": {
      "type": "object",
      "required": [
        "identification"
      ],
      "properties": {
        "identification": {
          "type": "object",
          "description": "Unique and unambiguous identification of a person.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Entity that assigns the identification.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "scheme_name": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/FinancialIdentificationSchemeName1Choice"
            }
          ]
        }
      },
      "description": "Unique identification of an agent, as assigned by an institution, using an identification scheme."
    },
    "GenericIdentification30": {
      "type": "object",
      "required": [
        "identification",
        "issuer"
      ],
      "properties": {
        "identification": {
          "type": "string",
          "description": "Proprietary information, often a code, issued by the data source scheme issuer.",
          "pattern": "[a-zA-Z0-9]{4}"
        },
        "issuer": {
          "type": "string",
          "description": "Entity that assigns the identification.",
          "minLength": 1,
          "maxLength": 35
        },
        "scheme_name": {
          "type": "string",
          "description": "Short textual description of the scheme.",
          "minLength": 1,
          "maxLength": 35
        }
      }
    },
    "GenericOrganisationIdentification1": {
      "type": "object",
      "required": [
        "identification"
      ],
      "properties": {
        "identification": {
          "type": "object",
          "description": "Identification assigned by an institution.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "scheme_name": {
          "type": "object",
          "description": "Name of the identification scheme.",
          "allOf": [
            {
              "$ref": "#/$defs/IdentificationSchemeName1Choice"
            }
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Entity that assigns the identification.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      }
    },
    "GenericPersonIdentification1": {
      "type": "object",
      "required": [
        "identification"
      ],
      "properties": {
        "identification": {
          "type": "object",
          "description": "Unique and unambiguous identification of a person.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "scheme_name": {
          "type": "object",
          "description": "Name of the identification scheme.",
          "allOf": [
            {
              "$ref": "#/$defs/IdentificationSchemeName1Choice"
            }
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Entity that assigns the identification.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Unique identification of a person, as assigned by an institution,using an identification scheme."
    },
    "GroupHeader80": {
      "required": [
        "creation_Date_time",
        "message_identification"
      ],
      "properties": {
        "message_identification": {
          "type": "object",
          "description": "Point to point reference, as assigned by the instructing party, and sent to the instructed party, to unambiguously identify the message.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "creation_Date_time": {
          "type": "object",
          "description": "Date and time at which the message was created.",
          "allOf": [
            {
              "$ref": "#/$defs/ISODateTime"
            }
          ]
        },
        "authorisation": {
          "type": "array",
          "description": "User identification or any user key to be used to check the authority of the initiating party.",
          "items": {
            "$ref": "#/$defs/Authorisation1Choice"
          },
          "maxItems": 2
        },
        "initiating_party": {
          "type": "object",
          "description": "Party that initiates the mandate message.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "instructing_agent": {
          "type": "object",
          "description": "Agent that is instructed by the previous party in the chain to carry out an instruction.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "instructed_agent": {
          "type": "object",
          "description": "Agent that is instructed by the previous party in the chain to carry out an instruction. In case of amendment and cancellation request messages, the instructed agent is the party receiving the amendment and cancellation request message and not the party that received the original mandate initiation request message. In case of acceptance report message, the instructed agent is the party receiving the acceptance report message and not the party that received the original mandate request message.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        }
      }
    },
    "IBAN2007Identifier": {
      "type": "string",
      "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
      "description": ">- International Bank Account Number (IBAN) - identifier 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."
    },
    "ISODate": {
      "type": "string",
      "format": "date"
    },
    "ISODateTime": {
      "type": "string",
      "format": "date-time"
    },
    "IdentificationSchemeName1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Name of the identification scheme, in a coded form as publishedin an external list.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "object",
          "description": "Name of the identification scheme, in free-form text.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      }
    },
    "LEIIdentifier": {
      "type": "string",
      "pattern": "[A-Z0-9]{18,18}[0-9]{2,2}"
    },
    "LocalInstrument2Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the external local instrument code in the format of character string with a maximum length of 35 characters. The list of valid codes is an external code list published separately.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "proprietary": {
          "type": "object",
          "description": "Specifies the local instrument, as a proprietary code.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "User community specific instrument. Either Code or Proprietary field value should be passed in request."
    },
    "Mandate13": {
      "type": "object",
      "required": [
        "creditor",
        "debtor",
        "debtor_agent",
        "mandate_request_identification",
        "tracking_identicator"
      ],
      "properties": {
        "mandate_identification": {
          "type": "array",
          "description": "Unique identification, as assigned by the responsible party(such as the creditor) or agent (such as the debtor agent), to unambiguously identify the mandate.",
          "items": {
            "$ref": "#/$defs/Max35Text"
          }
        },
        "mandate_request_identification": {
          "type": "object",
          "description": "Identification for the mandate request, as assigned by the initiating party.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "authentication": {
          "type": "object",
          "description": "Specifies the transport authentication details related to the mandate.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateAuthentication1"
            }
          ]
        },
        "type": {
          "type": "object",
          "description": "Specifies the type of mandate, such as paper, electronic or scheme.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateTypeInformation2"
            }
          ]
        },
        "occurences": {
          "type": "object",
          "description": "Provides details of the duration of the mandate and occurrenceof the underlying transactions.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateOccurrences4"
            }
          ]
        },
        "tracking_identicator": {
          "type": "boolean",
          "description": "Specifies whether the direct debit instructions should be automatically re-submitted periodically when bilaterally agreed. A flag indicating a True or False value."
        },
        "first_collection_amount": {
          "type": "object",
          "description": "Amount different from the collection amount, as it includesthe costs associated with the first debited amount.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveCurrencyAndAmount"
            }
          ]
        },
        "collection_amount": {
          "type": "object",
          "description": "Fixed amount to be collected from the debtor's account.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveCurrencyAndAmount"
            }
          ]
        },
        "maximum_amount": {
          "type": "object",
          "description": "Maximum amount that may be collected from the debtor's account,per instruction.",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveCurrencyAndAmount"
            }
          ]
        },
        "adjustment": {
          "type": "object",
          "description": "Specifies the characteristics of the adjustment applied to thecollection amount of a direct debit instruction.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateAdjustment1"
            }
          ]
        },
        "reason": {
          "type": "object",
          "description": "Provides the reason for the setup of the mandate.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateSetupReason1Choice"
            }
          ]
        },
        "creditor_scheme_identification": {
          "type": "object",
          "description": "Credit party that signs the mandate.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "creditor": {
          "type": "object",
          "description": "Party that signs the mandate and to whom an amount of moneyis due.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "creditor_account": {
          "type": "object",
          "description": "Unambiguous identification of the account of the creditor towhich a credit entry will be posted as a result of the payment transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "creditor_agent": {
          "type": "object",
          "description": "Financial institution servicing an account for the creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "ultimate_creditor": {
          "type": "object",
          "description": "Ultimate party to which an amount of money is due.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "debtor": {
          "type": "object",
          "description": "Party that signs the mandate and owes an amount of money to the (ultimate) creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "debtor_account": {
          "type": "object",
          "description": "Unambiguous identification of the account of the debtor, towhich a debit entry will be made as a result of the transaction.",
          "allOf": [
            {
              "$ref": "#/$defs/CashAccount38"
            }
          ]
        },
        "debtor_agent": {
          "type": "object",
          "description": "Financial institution servicing an account for the debtor.",
          "allOf": [
            {
              "$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
            }
          ]
        },
        "ultimate_debtor": {
          "type": "object",
          "description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
          "allOf": [
            {
              "$ref": "#/$defs/PartyIdentification135"
            }
          ]
        },
        "mandate_reference": {
          "type": "object",
          "description": "Reference assigned by a creditor or ultimate creditor for internal usage for the mandate.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "referred_document": {
          "type": "array",
          "description": "Provides information to identify the underlying documents associated with the mandate.",
          "items": {
            "$ref": "#/$defs/ReferredMandateDocument1"
          }
        },
        "supplementary_data": {
          "type": "array",
          "description": "Additional information that cannot be captured in the structured elements within the message component.",
          "items": {
            "$ref": "#/$defs/SupplementaryData1"
          }
        }
      },
      "description": "Information that serves as a basis to debit an account. Set of elements used to provide the details of the mandate signed between the (ultimate) creditorand the (ultimate) debtor. Ultimate Debtor may only be present if different from Debtor. Ultimate Creditor may only be present if different from Creditor."
    },
    "MandateAdjustment1": {
      "properties": {
        "date_adjustment_rule_indicator": {
          "type": "boolean",
          "description": "Specifies whether an adjustment is to be applied on pre-agreed collection date or not."
        },
        "category": {
          "type": "object",
          "description": "Defines the category of adjustment.",
          "allOf": [
            {
              "$ref": "#/$defs/Frequency37Choice"
            }
          ]
        },
        "amount": {
          "type": "object",
          "description": "Pre-agreed amount to increase or decrease the mandate amountas justified per information in the category",
          "allOf": [
            {
              "$ref": "#/$defs/ActiveCurrencyAndAmount"
            }
          ]
        },
        "rate": {
          "type": "string",
          "description": "Pre-agreed increase or decrease rate that will be applied to the collection amount. Total Digits 11 are allowed and up to 10 fractional digits"
        }
      },
      "description": "Specifies the characteristics of the adjustment applied to the collection amount of a direct debit instruction."
    },
    "MandateAuthentication1": {
      "properties": {
        "message_authentication_code": {
          "type": "string",
          "description": "Specifies a piece of information used to authenticate a message,that is to confirm that the message came from the stated sender (its authenticity)and has not been changed in transit (its integrity).",
          "minLength": 1,
          "maxLength": 16
        },
        "date": {
          "type": "string",
          "format": "date",
          "description": "Date when the authentication was conducted."
        },
        "channel": {
          "type": "object",
          "description": "Channel used to transmit the authentication information",
          "allOf": [
            {
              "$ref": "#/$defs/AuthenticationChannel1Choice"
            }
          ]
        }
      }
    },
    "MandateClassification1Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the type of direct debit amount, such as fixed or variable.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateClassification1Code"
            }
          ]
        },
        "proprietary": {
          "type": "object",
          "description": "Proprietary Details",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Either from Code or Proprietary is Required"
    },
    "MandateClassification1Code": {
      "type": "string",
      "description": "Specifies the type of direct debit amount, such as fixed or variable. FIXE - Direct debit amount is fixed. USGB - Direct debit amount is based on usage. VARI - Direct debit amount is variable.",
      "enum": [
        "FIXE",
        "USGB",
        "VARI"
      ]
    },
    "MandateInitiationRequestV06": {
      "type": "object",
      "required": [
        "group_header"
      ],
      "properties": {
        "group_header": {
          "type": "object",
          "description": "Set of characteristics to identify the message and parties playing a role in the mandate initiation, but which are not part of the mandate.",
          "allOf": [
            {
              "$ref": "#/$defs/GroupHeader80"
            }
          ]
        },
        "mandate": {
          "type": "array",
          "description": "Set of elements used to provide the details of the mandate signed between the ultimate creditor and the ultimate debtor. Information that serves as a basis to debit an account.",
          "items": {
            "$ref": "#/$defs/Mandate13"
          }
        },
        "supplementary_data": {
          "type": "array",
          "description": "Additional information that cannot be captured in the structured elements and/or any other specific block. The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose.",
          "items": {
            "$ref": "#/$defs/SupplementaryData1"
          }
        }
      },
      "description": "The CreditorPaymentActivationRequestStatusReport message is sent by a party to the next party in the creditor payment activation request chain. It is used to inform the latter about the positive or negative status of a creditor payment activation request (either single or file)."
    },
    "MandateOccurrences4": {
      "type": "object",
      "required": [
        "sequence_type"
      ],
      "properties": {
        "sequence_type": {
          "type": "string",
          "description": "Identifies the underlying transaction sequence as either recurring or one-off. RCUR - Direct debit instruction where the debtor's authorization is used for regular direct debit transactions initiated by the creditor. OOFF - Direct debit instruction where the debtor's authorization is used to initiate one single direct debit transaction."
        },
        "Frqcy": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/Frequency36Choice"
            }
          ]
        },
        "Drtn": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/DatePeriodDetails1"
            }
          ]
        },
        "first_collection_date": {
          "type": "string",
          "format": "date",
          "description": "Date of the first collection of a direct debit as per the mandate."
        },
        "final_collection_date": {
          "type": "string",
          "format": "date",
          "description": "Date of the final collection of a direct debit as per the mandate."
        }
      },
      "description": "Provides details of the duration of the mandate and occurrence ofthe underlying transactions."
    },
    "MandateSetupReason1Choice": {
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the external mandate setup reason code in the format of character string with a maximum length of 4 characters.",
          "minLength": 1,
          "maxLength": 4
        },
        "proprietary": {
          "type": "object",
          "description": "Propreitary details",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        }
      },
      "description": "Provides the reason for the setup of the mandate. Either from Code or Proprietary is Required"
    },
    "MandateTypeInformation2": {
      "properties": {
        "service_level": {
          "type": "object",
          "description": "Agreement under which or rules under which the mandate resides.",
          "allOf": [
            {
              "$ref": "#/$defs/ServiceLevel8Choice"
            }
          ]
        },
        "LclInstrm": {
          "type": "object",
          "description": "User community specific instrument. This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.",
          "allOf": [
            {
              "$ref": "#/$defs/LocalInstrument2Choice"
            }
          ]
        },
        "category_purpose": {
          "type": "object",
          "description": "Specifies the high level purpose of the mandate based on a set of pre-defined categories.",
          "allOf": [
            {
              "$ref": "#/$defs/CategoryPurpose1Choice"
            }
          ]
        },
        "classification": {
          "type": "object",
          "description": "Type of direct debit instruction.",
          "allOf": [
            {
              "$ref": "#/$defs/MandateClassification1Choice"
            }
          ]
        }
      },
      "description": "Specifies the type of mandate, such as paper, electronic or scheme."
    },
    "Max128Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "Max140Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 140
    },
    "Max16Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 16
    },
    "Max2048Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "Max34Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 34
    },
    "Max350Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 350
    },
    "Max35Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 35
    },
    "Max4Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4
    },
    "Max70Text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 70
    },
    "NamePrefix2Code": {
      "type": "string",
      "description": "Specifies the terms used to formally address a person.<br><br><b>DOCT</b>: Title of the person is Doctor or Dr. <br><br><b>MIST</b>: Title of the person is Mister or Mr. <br><br><b>MISS</b>: Title of the person is Miss.<br><br><b>MADM</b>: Title of the person is Madam.<br><br><b>MIKS</b>: Title of the person is Gender Neutral.",
      "enum": [
        "DOCT",
        "MADM",
        "MISS",
        "MIST",
        "MIKS"
      ]
    },
    "OrganisationIdentification29": {
      "type": "object",
      "properties": {
        "any_bic": {
          "type": "object",
          "description": "Business identification code of the organisation.  Code allocatedto a financial or non-financial institution by the ISO 9362 RegistrationAuthority, as described in ISO 9362: 2014 - Banking - Banking telecommunicationmessages - Business identifier code (BIC).Only a valid Business identifiercode is allowed. Business identifier codes for financial or non-financialinstitutions are registered and published by the ISO 9362 RegistrationAuthority in the ISO directory of BICs, and consists of eight (8) or eleven(11) contiguous characters.",
          "allOf": [
            {
              "$ref": "#/$defs/AnyBICDec2014Identifier"
            }
          ]
        },
        "legal_entity": {
          "type": "object",
          "description": "Legal entity identification as an alternate identification fora party.",
          "allOf": [
            {
              "$ref": "#/$defs/LEIIdentifier"
            }
          ]
        },
        "other": {
          "type": "array",
          "description": "Unique identification of an organization, as assigned by an institution, using an identification scheme.",
          "items": {
            "$ref": "#/$defs/GenericOrganisationIdentification1"
          }
        }
      }
    },
    "OtherContact1": {
      "type": "object",
      "required": [
        "channel_type"
      ],
      "properties": {
        "channel_type": {
          "type": "object",
          "description": "Method used to contact the financial institution’s contact forthe specific tax region.",
          "allOf": [
            {
              "$ref": "#/$defs/Max4Text"
            }
          ]
        },
        "identification": {
          "type": "object",
          "description": "Communication value such as phone number or email address.",
          "allOf": [
            {
              "$ref": "#/$defs/Max128Text"
            }
          ]
        }
      }
    },
    "Party38Choice": {
      "type": "object",
      "properties": {
        "organisation_identification": {
          "type": "object",
          "description": "Unique and unambiguous way to identify an organization.",
          "allOf": [
            {
              "$ref": "#/$defs/OrganisationIdentification29"
            }
          ]
        },
        "PrvtId": {
          "type": "object",
          "description": "Unique and unambiguous way to identify a person.",
          "allOf": [
            {
              "$ref": "#/$defs/PersonIdentification13"
            }
          ]
        }
      },
      "description": "Unique and unambiguous identification of a party. Either from OrganisationIdentification and Private Identification is required."
    },
    "PartyIdentification135": {
      "type": "object",
      "properties": {
        "Nm": {
          "type": "object",
          "description": "Name by which a party is known and which is usually used to identify that party.",
          "allOf": [
            {
              "$ref": "#/$defs/Max140Text"
            }
          ]
        },
        "postal_address": {
          "type": "object",
          "description": "Information that locates and identifies a specific address, as defined by postal services.",
          "allOf": [
            {
              "$ref": "#/$defs/PostalAddress24"
            }
          ]
        },
        "Id": {
          "type": "object",
          "description": "Unique and unambiguous identification of a party. Should pass EITHER OrgId or PrvtId for organisation and private respectively.",
          "allOf": [
            {
              "$ref": "#/$defs/Party38Choice"
            }
          ]
        },
        "country_of_residence": {
          "type": "object",
          "description": "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.",
          "allOf": [
            {
              "$ref": "#/$defs/CountryCode"
            }
          ]
        },
        "contact_details": {
          "type": "object",
          "description": "Set of elements used to indicate how to contact the party.",
          "allOf": [
            {
              "$ref": "#/$defs/Contact4"
            }
          ]
        }
      }
    },
    "PersonIdentification13": {
      "type": "object",
      "properties": {
        "date_and_place_of_birth": {
          "type": "object",
          "description": "Date and place of birth of a person.",
          "allOf": [
            {
              "$ref": "#/$defs/DateAndPlaceOfBirth1"
            }
          ]
        },
        "other": {
          "type": "array",
          "description": "Unique identification of a person, as assigned by an institution, using an identification scheme.",
          "items": {
            "$ref": "#/$defs/GenericPersonIdentification1"
          }
        }
      }
    },
    "PhoneNumber": {
      "type": "string",
      "pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"
    },
    "PostalAddress24": {
      "type": "object",
      "properties": {
        "AdrLine": {
          "type": "array",
          "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
          "items": {
            "type": "string"
          },
          "maxItems": 7
        },
        "AdrTp": {
          "type": "object",
          "description": "Identifies the nature of the postal address. Either Code or Proprietary is required",
          "allOf": [
            {
              "$ref": "#/$defs/AddressType3Choice"
            }
          ]
        },
        "BldgNm": {
          "type": "string",
          "description": "Name of the building or house.",
          "minLength": 1,
          "maxLength": 35
        },
        "BldgNb": {
          "type": "object",
          "description": "Number that identifies the position of a building on a street.",
          "allOf": [
            {
              "$ref": "#/$defs/Max16Text"
            }
          ]
        },
        "Ctry": {
          "$ref": "#/$defs/CountryCode"
        },
        "CtrySubDvsn": {
          "type": "object",
          "description": "Identifies a subdivision of a country such as state, region, or county.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "Dept": {
          "type": "object",
          "description": "Identification of a division of a large organisation or building.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "PstCd": {
          "type": "object",
          "description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
          "allOf": [
            {
              "$ref": "#/$defs/Max16Text"
            }
          ]
        },
        "StrtNm": {
          "type": "object",
          "description": "Name of a street or thoroughfare.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "SubDept": {
          "type": "object",
          "description": "Identification of a sub-division of a large organization or building.",
          "allOf": [
            {
              "$ref": "#/$defs/Max70Text"
            }
          ]
        },
        "TwnNm": {
          "type": "object",
          "description": "Name of a built-up area, with defined boundaries, and a local government.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "TwnLctnNm": {
          "type": "string",
          "description": "Specific location name within the town.",
          "minLength": 1,
          "maxLength": 35
        },
        "PstBx": {
          "type": "string",
          "description": "Name of a built-up area, with defined boundaries, and a local government.",
          "minLength": 1,
          "maxLength": 16
        },
        "Flr": {
          "type": "string",
          "description": "Floor or story within a building.",
          "minLength": 1,
          "maxLength": 70
        },
        "Room": {
          "type": "string",
          "description": "Building room number.",
          "minLength": 1,
          "maxLength": 70
        },
        "DstrctNm": {
          "type": "string",
          "description": "Identifies a subdivision within a country sub-division.",
          "minLength": 1,
          "maxLength": 35
        }
      },
      "description": "Information that locates and identifies a specific address, as defined by postal services."
    },
    "PreferredContactMethod1Code": {
      "type": "string",
      "description": "Preferred method used to reach the individual contact within an organization. <br><br><b>LETT</b>: Preferred method used to reach the contact is per letter. <br><br><b>FAXX</b>: Preferred method used to reach the contact is per fax.<br><br><b>PHON</b>: Preferred method used to reach the contact is per phone. <br><br><b>MAIL</b>: Preferred method used to reach the contact is per email .<br><br><b>CELL</b : Preferred method used to reach the contact is per mobile or cell phone.",
      "enum": [
        "LETT",
        "FAXX",
        "PHON",
        "MAIL",
        "CELL"
      ]
    },
    "ReferredDocumentType3Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies a type of financial or commercial document.",
          "allOf": [
            {
              "$ref": "#/$defs/DocumentType6Code"
            }
          ]
        },
        "proprietary": {
          "type": "object",
          "description": "Specifies a proprietary type of financial or commercial document.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Either from Code or Proprietary is Required"
    },
    "ReferredDocumentType4": {
      "type": "object",
      "required": [
        "code_or_proprietary"
      ],
      "properties": {
        "code_or_proprietary": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/$defs/ReferredDocumentType3Choice"
            }
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Identification of the issuer of the reference document type.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Specifies the type of referred document."
    },
    "ReferredMandateDocument1": {
      "type": "object",
      "properties": {
        "type": {
          "type": "object",
          "description": "Specifies the type of referred document.",
          "allOf": [
            {
              "$ref": "#/$defs/ReferredDocumentType4"
            }
          ]
        },
        "number": {
          "type": "object",
          "description": "Unique and unambiguous identification of the referred document.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "creditor_reference": {
          "type": "object",
          "description": "Unique and unambiguous identification as assigned by the creditor to the referred document shared with the debtor for its own reference.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        },
        "related_date": {
          "type": "string",
          "format": "date",
          "description": "Date associated with the referred document."
        }
      },
      "description": "Provides information to identify the underlying documents associated with the mandate."
    },
    "ServiceLevel8Choice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "object",
          "description": "Specifies the external service level code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately.",
          "allOf": [
            {
              "$ref": "#/$defs/Max4Text"
            }
          ]
        },
        "proprietary": {
          "type": "object",
          "description": "Specifies a pre-agreed service or level of service between the parties, as a proprietary code.",
          "allOf": [
            {
              "$ref": "#/$defs/Max35Text"
            }
          ]
        }
      },
      "description": "Agreement under which or rules under which the transaction should be processed. Either code or proprietary field values should be sent in request."
    },
    "SupplementaryData1": {
      "type": "object",
      "required": [
        "envelope"
      ],
      "properties": {
        "place_and_name": {
          "type": "object",
          "description": "Unambiguous reference to the location where the supplementary data must be inserted in the message instance.",
          "allOf": [
            {
              "$ref": "#/$defs/Max350Text"
            }
          ]
        },
        "envelope": {
          "type": "string",
          "description": "Technical element wrapping the supplementary data. Elements from any namespace is allowed. Process Contents is 'lax' Specifies how the XML processor should handle validation against the elements specified by this any element. if the schema cannot be obtained, no errors will occur."
        }
      },
      "description": "Additional information that cannot be captured in the structured elements and/or any other specific block. This component may not be used without the explicit approval of a SEG and submission to the RA of ISO 20022 compliant structure(s) to be used in the envelope element."
    }
  }
}