{ "AccountIdentification4Choice": { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, "AccountSchemeName1Choice": { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, "ActiveCurrencyAndAmount": { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, "ActiveCurrencyAndAmount_SimpleType": { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 }, "ActiveCurrencyCode": { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, "ActiveOrHistoricCurrencyAndAmount": { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, "ActiveOrHistoricCurrencyAndAmount_SimpleType": { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, "ActiveOrHistoricCurrencyCode": { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, "AddressType2Code": { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, "AddressType3Choice": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "AmountTypeEnum": { "title": "AmountTypeEnum", "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", "enum": [ "SEND", "RECEIVE" ], "example": "SEND" }, "AnyBICDec2014Identifier": { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, "BICFIDec2014Identifier": { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, "BaseOneRate": { "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", "example": 0.7, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, "BranchAndFinancialInstitutionIdentification6": { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, "BranchAndFinancialInstitutionIdentification8": { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, "BranchData3": { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, "BranchData5": { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, "CashAccount40": { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, "CashAccountType2Choice": { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, "CategoryPurpose1Choice": { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, "ChargeBearerType1Code": { "title": "ChargeBearerType1Code", "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", "SHAR" ], "example": "DEBT" }, "ChargeType3Choice": { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, "Charges16": { "title": "Charges16", "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", "type": "object", "additionalProperties": false, "properties": { "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, "Tp": { "allOf": [ { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ "Amt", "Agt" ], "example": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } } }, "ClearingChannel2Code": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "ClearingSystemIdentification2Choice": { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, "ClearingSystemMemberIdentification2": { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, "Contact13": { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, "Contact4": { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, "CountryCode": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "CreditTransferTransaction67": { "title": "CreditTransferTransaction67", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "XchgRate": { "allOf": [ { "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", "example": 0.7, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" } ] }, "ChrgBr": { "title": "ChargeBearerType1Code", "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", "SHAR" ], "example": "DEBT" }, "ChrgsInf": { "allOf": [ { "title": "Charges16", "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", "type": "object", "additionalProperties": false, "properties": { "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, "Tp": { "allOf": [ { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ "Amt", "Agt" ], "example": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } } }, { "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "InstrForNxtAgt": { "allOf": [ { "title": "InstructionForNextAgent1", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "RgltryRptg": { "allOf": [ { "title": "RegulatoryReporting3", "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "DbtCdtRptgInd": { "allOf": [ { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, { "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" } ] }, "Authrty": { "allOf": [ { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, { "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, "Dtls": { "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", "anyOf": [ { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, { "items": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "type": "array" } ] } }, "example": { "DbtCdtRptgInd": "CRED", "Authrty": { "Nm": "Swiss National Bank", "Ctry": "CH" }, "Dtls": { "Cd": "A1", "Inf": "Mandatory regulatory information" } } }, { "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, "Tax": { "allOf": [ { "title": "TaxData1", "description": "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.\n", "type": "object", "additionalProperties": false, "properties": { "Cdtr": { "allOf": [ { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, { "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, "Dbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, "UltmtDbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, "AdmstnZone": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" } ] }, "RefNb": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, "Mtd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, "TtlTaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate by which tax is due.\n" } ] }, "SeqNb": { "allOf": [ { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, "Rcrd": { "description": "Record\n\nDetails of the tax record.\n", "anyOf": [ { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, { "items": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "type": "array" } ] } }, "example": { "Cdtr": { "Titl": "Mr", "Nm": "John Doe" }, "Dbtr": { "Titl": "Mr", "Nm": "John Doe" }, "UltmtDbtr": { "Titl": "Mr", "Nm": "John Doe" }, "AdmstnZone": "CH", "RefNb": 12345, "Mtd": "A", "TtlTaxblBaseAmt": { "Ccy": "CHF", "Amt": 1000 }, "TtlTaxAmt": { "Ccy": "CHF", "Amt": 100 }, "Dt": "2018-01-01", "SeqNb": 1, "Rcrd": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "Tax\nProvides details on the tax.\n" } ] }, "VrfctnOfTerms": { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } } }, "required": [ "PmtId", "IntrBkSttlmAmt", "ChrgBr", "Dbtr", "DbtrAgt", "CdtrAgt", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" }, "SeqTp": "SEQTP" }, "IntrBkSttlmAmt": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" }, "InstdAmt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "XchgRate": 123.45, "ChrgBr": "SHAR", "ChrgsInf": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } }, "Dbtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "CODE" }, "InstrForNxtAgt": { "Cd": "CODE" }, "Purp": { "Cd": "CASH" }, "RgltryRptg": { "Dbtr": true, "Cdtr": true }, "Tax": "Cdtr" } }, "CreditTransferTransaction68": { "title": "CreditTransferTransaction68", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "VrfctnOfTerms": { "allOf": [ { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, { "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ "PmtId", "IntrBkSttlmAmt", "Dbtr", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" } }, "IntrBkSttlmAmt": { "Amount": 123.45, "Ccy": "EUR" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "INSTRUCTION" }, "Purp": { "Cd": "CHAR" }, "VrfctnOfTerms": { "Cntt": "CONTENT", "CnttTp": "PROPRIETARY" } } }, "CreditTransferTransaction68_FX_Quotes": { "title": "CreditTransferTransaction68_FX_Quotes", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "AmountTypeEnum", "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", "enum": [ "SEND", "RECEIVE" ], "example": "SEND" }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "VrfctnOfTerms": { "allOf": [ { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, { "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ "PmtId", "IntrBkSttlmAmt", "Dbtr", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" } }, "IntrBkSttlmAmt": { "Amount": 123.45, "Ccy": "EUR" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "INSTRUCTION" }, "Purp": { "Cd": "CHAR" }, "VrfctnOfTerms": { "Cntt": "CONTENT", "CnttTp": "PROPRIETARY" } } }, "CryptographicLockChoice": { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, "DateAndDateTime2Choice": { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\nSpecified date.\n" } ] } }, "required": [ "Dt" ] }, { "properties": { "DtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "DateTime\nSpecified date and time.\n" } ] } }, "required": [ "DtTm" ] } ], "example": { "DtTm": "2020-01-01T00:00:00Z" } }, "DateAndPlaceOfBirth1": { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, "DatePeriod2": { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, "ErrorCode": { "title": "ErrorCode", "type": "string", "pattern": "^[1-9]\\d{3}$", "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", "example": "5100" }, "ErrorDescription": { "title": "ErrorDescription", "type": "string", "minLength": 1, "maxLength": 128, "description": "Error description string." }, "ErrorInformation": { "title": "ErrorInformation", "type": "object", "additionalProperties": false, "description": "Data model for the complex type ErrorInformation.", "properties": { "errorCode": { "title": "ErrorCode", "type": "string", "pattern": "^[1-9]\\d{3}$", "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", "example": "5100" }, "errorDescription": { "title": "ErrorDescription", "type": "string", "minLength": 1, "maxLength": 128, "description": "Error description string." }, "extensionList": { "title": "ExtensionList", "type": "object", "additionalProperties": false, "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", "properties": { "extension": { "type": "array", "items": { "title": "Extension", "type": "object", "additionalProperties": false, "description": "Data model for the complex type Extension.", "properties": { "key": { "title": "ExtensionKey", "type": "string", "minLength": 1, "maxLength": 32, "description": "Extension key." }, "value": { "title": "ExtensionValue", "type": "string", "minLength": 1, "maxLength": 128, "description": "Extension value." } }, "required": [ "key", "value" ] }, "minItems": 1, "maxItems": 16, "description": "Number of Extension elements." } }, "required": [ "extension" ] } }, "required": [ "errorCode", "errorDescription" ] }, "ErrorInformationResponse": { "title": "ErrorInformationResponse", "type": "object", "additionalProperties": false, "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n", "properties": { "errorInformation": { "title": "ErrorInformation", "type": "object", "additionalProperties": false, "description": "Data model for the complex type ErrorInformation.", "properties": { "errorCode": { "title": "ErrorCode", "type": "string", "pattern": "^[1-9]\\d{3}$", "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", "example": "5100" }, "errorDescription": { "title": "ErrorDescription", "type": "string", "minLength": 1, "maxLength": 128, "description": "Error description string." }, "extensionList": { "title": "ExtensionList", "type": "object", "additionalProperties": false, "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", "properties": { "extension": { "type": "array", "items": { "title": "Extension", "type": "object", "additionalProperties": false, "description": "Data model for the complex type Extension.", "properties": { "key": { "title": "ExtensionKey", "type": "string", "minLength": 1, "maxLength": 32, "description": "Extension key." }, "value": { "title": "ExtensionValue", "type": "string", "minLength": 1, "maxLength": 128, "description": "Extension value." } }, "required": [ "key", "value" ] }, "minItems": 1, "maxItems": 16, "description": "Number of Extension elements." } }, "required": [ "extension" ] } }, "required": [ "errorCode", "errorDescription" ] } } }, "Exact32HexBinaryText": { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, "Exact4AlphaNumericText": { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, "Execute_FIToFICustomerCreditTransferV13": { "title": "Execute_FIToFICustomerCreditTransferV13", "type": "object", "additionalProperties": false, "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader129", "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "PmtInstrXpryDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Payment Instruction Expiry Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } } }, { "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction67", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "XchgRate": { "allOf": [ { "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", "example": 0.7, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" } ] }, "ChrgBr": { "title": "ChargeBearerType1Code", "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", "SHAR" ], "example": "DEBT" }, "ChrgsInf": { "allOf": [ { "title": "Charges16", "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", "type": "object", "additionalProperties": false, "properties": { "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, "Tp": { "allOf": [ { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ "Amt", "Agt" ], "example": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } } }, { "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "InstrForNxtAgt": { "allOf": [ { "title": "InstructionForNextAgent1", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "RgltryRptg": { "allOf": [ { "title": "RegulatoryReporting3", "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "DbtCdtRptgInd": { "allOf": [ { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, { "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" } ] }, "Authrty": { "allOf": [ { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, { "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, "Dtls": { "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", "anyOf": [ { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, { "items": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "type": "array" } ] } }, "example": { "DbtCdtRptgInd": "CRED", "Authrty": { "Nm": "Swiss National Bank", "Ctry": "CH" }, "Dtls": { "Cd": "A1", "Inf": "Mandatory regulatory information" } } }, { "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, "Tax": { "allOf": [ { "title": "TaxData1", "description": "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.\n", "type": "object", "additionalProperties": false, "properties": { "Cdtr": { "allOf": [ { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, { "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, "Dbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, "UltmtDbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, "AdmstnZone": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" } ] }, "RefNb": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, "Mtd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, "TtlTaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate by which tax is due.\n" } ] }, "SeqNb": { "allOf": [ { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, "Rcrd": { "description": "Record\n\nDetails of the tax record.\n", "anyOf": [ { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, { "items": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "type": "array" } ] } }, "example": { "Cdtr": { "Titl": "Mr", "Nm": "John Doe" }, "Dbtr": { "Titl": "Mr", "Nm": "John Doe" }, "UltmtDbtr": { "Titl": "Mr", "Nm": "John Doe" }, "AdmstnZone": "CH", "RefNb": 12345, "Mtd": "A", "TtlTaxblBaseAmt": { "Ccy": "CHF", "Amt": 1000 }, "TtlTaxAmt": { "Ccy": "CHF", "Amt": 100 }, "Dt": "2018-01-01", "SeqNb": 1, "Rcrd": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "Tax\nProvides details on the tax.\n" } ] }, "VrfctnOfTerms": { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } } }, "required": [ "PmtId", "IntrBkSttlmAmt", "ChrgBr", "Dbtr", "DbtrAgt", "CdtrAgt", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" }, "SeqTp": "SEQTP" }, "IntrBkSttlmAmt": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" }, "InstdAmt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "XchgRate": 123.45, "ChrgBr": "SHAR", "ChrgsInf": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } }, "Dbtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "CODE" }, "InstrForNxtAgt": { "Cd": "CODE" }, "Purp": { "Cd": "CASH" }, "RgltryRptg": { "Dbtr": true, "Cdtr": true }, "Tax": "Cdtr" } }, { "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } }, "CdtTrfTxInf": { "PmtId": { "InstrId": 123, "EndToEndId": 123 }, "PmtTpInf": { "InstrPrty": "NORM" }, "InstdAmt": { "Amt": 123, "Ccy": "EUR" }, "ChrgBr": "SHAR", "CdtrAgt": { "FinInstnId": { "BICFI": 123 } }, "Cdtr": { "Nm": "John Doe" }, "CdtrAcct": { "Id": { "IBAN": 123 } }, "RmtInf": { "Ustrd": "Test" } } } }, "Extension": { "title": "Extension", "type": "object", "additionalProperties": false, "description": "Data model for the complex type Extension.", "properties": { "key": { "title": "ExtensionKey", "type": "string", "minLength": 1, "maxLength": 32, "description": "Extension key." }, "value": { "title": "ExtensionValue", "type": "string", "minLength": 1, "maxLength": 128, "description": "Extension value." } }, "required": [ "key", "value" ] }, "ExtensionKey": { "title": "ExtensionKey", "type": "string", "minLength": 1, "maxLength": 32, "description": "Extension key." }, "ExtensionList": { "title": "ExtensionList", "type": "object", "additionalProperties": false, "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", "properties": { "extension": { "type": "array", "items": { "title": "Extension", "type": "object", "additionalProperties": false, "description": "Data model for the complex type Extension.", "properties": { "key": { "title": "ExtensionKey", "type": "string", "minLength": 1, "maxLength": 32, "description": "Extension key." }, "value": { "title": "ExtensionValue", "type": "string", "minLength": 1, "maxLength": 128, "description": "Extension value." } }, "required": [ "key", "value" ] }, "minItems": 1, "maxItems": 16, "description": "Number of Extension elements." } }, "required": [ "extension" ] }, "ExtensionValue": { "title": "ExtensionValue", "type": "string", "minLength": 1, "maxLength": 128, "description": "Extension value." }, "ExternalAccountIdentification1Code": { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalCashAccountType1Code": { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalCategoryPurpose1Code": { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, "ExternalChargeType1Code": { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalClearingSystemIdentification1Code": { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, "ExternalCreditorAgentInstruction1Code": { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalFinancialInstitutionIdentification1Code": { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalLocalInstrument1Code": { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, "ExternalOrganisationIdentification1Code": { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalPaymentTransactionStatus1Code": { "title": "ExternalPaymentTransactionStatus1Code", "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": "COMM", "enum": [ "COMM", "RESV", "RECV", "ABOR" ] }, "ExternalPersonIdentification1Code": { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalProxyAccountType1Code": { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalPurpose1Code": { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalServiceLevel1Code": { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalStatusReason1Code": { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "ExternalVerificationReason1Code": { "title": "ExternalVerificationReason1Code", "description": "Specifies the external verification reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "FinancialIdentificationSchemeName1Choice": { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, "FinancialInstitutionIdentification18": { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, "FinancialInstitutionIdentification23": { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, "FxRequest_FICreditTransferProposal": { "title": "FxRequest_FICreditTransferProposal", "type": "object", "additionalProperties": false, "description": "FxRequest_FICreditTransferProposal\nA group of elements providing information specific to the individual credit transfer(s) included in the message.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader113", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "TtlIntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Total Interbank Settlement Amount\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "Payment Type Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "TtlIntrBkSttlmAmt": { "Ccy": "EUR", "Value": 100 }, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "SttlmAcctOwnr": { "Nm": "Name" }, "SttlmAcctSvcr": { "Nm": "Name" }, "SttlmAgt": { "FinInstnId": { "BICFI": "BIC" } } }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": "CASH" } } }, { "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction68_FX_Quotes", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "AmountTypeEnum", "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", "enum": [ "SEND", "RECEIVE" ], "example": "SEND" }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "VrfctnOfTerms": { "allOf": [ { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, { "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ "PmtId", "IntrBkSttlmAmt", "Dbtr", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" } }, "IntrBkSttlmAmt": { "Amount": 123.45, "Ccy": "EUR" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "INSTRUCTION" }, "Purp": { "Cd": "CHAR" }, "VrfctnOfTerms": { "Cntt": "CONTENT", "CnttTp": "PROPRIETARY" } } }, { "description": "Credit Transfer Transaction Information\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "TtlIntrBkSttlmAmt": { "Ccy": "EUR", "Value": 100 }, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "SttlmAcctOwnr": { "Nm": "Name" }, "SttlmAcctSvcr": { "Nm": "Name" }, "SttlmAgt": { "FinInstnId": { "BICFI": "BIC" } } }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": "CASH" }, "CdtTrfTxInf": { "PmtId": { "InstrId": 12345, "EndToEndId": 12345 }, "Amt": { "InstdAmt": { "Ccy": "EUR", "Value": 100 } }, "Cdtr": { "Nm": "Name" }, "CdtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "CdtrAgt": { "FinInstnId": { "BICFI": "BIC" } }, "Dbtr": { "Nm": "Name" }, "DbtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "DbtrAgt": { "FinInstnId": { "BICFI": "BIC" } }, "IntrBkSttlmAmt": { "Ccy": "EUR", "Value": 100 }, "PmtTpInf": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } }, "RgltryRptg": { "Dbtr": { "Nm": "Name" }, "DbtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "DbtrAgt": { "FinInstnId": { "BICFI": "BIC" } }, "Cdtr": { "Nm": "Name" } } } } } }, "FxResponse_FICreditTransferConfirmation": { "title": "FxResponse_FICreditTransferConfirmation", "type": "object", "additionalProperties": false, "description": "FxResponse_FICreditTransferConfirmation\nThe FxResponse_FICreditTransferConfirmation message is sent by the FSP to the Payer FSP to confirm the successful processing of the credit transfer.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader113", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "TtlIntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Total Interbank Settlement Amount\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "Payment Type Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "TtlIntrBkSttlmAmt": { "Ccy": "EUR", "Value": 100 }, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "SttlmAcctOwnr": { "Nm": "Name" }, "SttlmAcctSvcr": { "Nm": "Name" }, "SttlmAgt": { "FinInstnId": { "BICFI": "BIC" } } }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": "CASH" } } }, { "description": "GroupHeader\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction68_FX_Quotes", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "AmountTypeEnum", "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", "enum": [ "SEND", "RECEIVE" ], "example": "SEND" }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "VrfctnOfTerms": { "allOf": [ { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, { "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ "PmtId", "IntrBkSttlmAmt", "Dbtr", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" } }, "IntrBkSttlmAmt": { "Amount": 123.45, "Ccy": "EUR" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "INSTRUCTION" }, "Purp": { "Cd": "CHAR" }, "VrfctnOfTerms": { "Cntt": "CONTENT", "CnttTp": "PROPRIETARY" } } }, { "description": "CreditTransferTransaction68_FX_Quotes\nSet of elements providing information specific to the individual credit transfer(s).\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": "20191122-123456", "CreDtTm": "2019-11-22T12:34:56", "NbOfTxs": 1, "CtrlSum": 100, "InitgPty": { "Nm": "Initiating Party Name" }, "MsgRcpt": { "Nm": "Message Recipient Name" } }, "CdtTrfTxInf": { "PmtId": { "InstrId": "20191122-123456", "EndToEndId": "20191122-123456" }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": "SUPP" }, "IntrBkSttlmAmt": { "Amt": 100, "Ccy": "EUR" }, "ChrgBr": "SHAR", "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account" }, "CdtrAgt": { "FinInstnId": { "BICFI": "BNBABEBB" } }, "CdtrAgtAcct": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account" }, "DbtrAgt": { "FinInstnId": { "BICFI": "BNBABEBB" } }, "DbtrAgtAcct": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account" }, "RmtInf": { "Ustrd": "Remittance Information" }, "RgltryRptg": { "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account" } } } } }, "Fxecute_FinancialInstitutionCreditTransferV12": { "title": "Fxecute_FinancialInstitutionCreditTransferV12", "type": "object", "additionalProperties": false, "description": "The Fxecute FinancialInstitutionCreditTransfer message is sent by the initiating party to the executing party to request the execution of a payment. It is used to request movement of funds from the debtor account to the creditor account. The message can carry multiple credit transfer instructions.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader129", "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "PmtInstrXpryDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Payment Instruction Expiry Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } } }, { "description": "GroupHeader.\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction68", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "Dbtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nAccount used to process a payment.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nAccount to which a credit entry is made.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "VrfctnOfTerms": { "allOf": [ { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } }, { "description": "VerificationOfTerms\nSet of elements used to provide information on the underlying terms of the transaction.\n" } ] } }, "required": [ "PmtId", "IntrBkSttlmAmt", "Dbtr", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" } }, "IntrBkSttlmAmt": { "Amount": 123.45, "Ccy": "EUR" }, "Dbtr": { "Nm": "Debtor Name" }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "INSTRUCTION" }, "Purp": { "Cd": "CHAR" }, "VrfctnOfTerms": { "Cntt": "CONTENT", "CnttTp": "PROPRIETARY" } } }, { "description": "CreditTransferTransactionInformation.\nSet of elements providing information specific to the individual credit transfer(s).\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": 20191113001, "CreDtTm": "2019-11-13T10:00:00", "NbOfTxs": 1, "CtrlSum": 1000, "InitgPty": { "Nm": "Initiating Party Name", "Id": { "OrgId": { "Othr": { "Id": 123456789, "SchmeNm": { "Cd": "BBA" } } } } }, "FwdgAgt": { "FinInstnId": { "BICFI": "BBBBBBBB" } }, "DbtrAgt": { "FinInstnId": { "BICFI": "AAAAAAAA" } }, "CdtrAgt": { "FinInstnId": { "BICFI": "CCCCCCCC" } } }, "CdtTrfTxInf": { "PmtId": { "InstrId": 20191113001, "EndToEndId": 20191113001 }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": { "Cd": "SUPP" } }, "InstrForCdtrAgt": { "Cd": "/ACC/123456789" }, "IntrBkSttlmAmt": { "Amt": 1000, "Ccy": "EUR" }, "ChrgBr": "SHAR", "CdtrAgt": { "FinInstnId": { "BICFI": "CCCCCCCC" } }, "Cdtr": { "Nm": "Creditor Name" }, "CdtrAcct": { "Id": { "IBAN": "BE71096123456769" } }, "RmtInf": { "Ustrd": "Payment for invoice 12345" } } } }, "GenericAccountIdentification1": { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, "GenericFinancialIdentification1": { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, "GenericIdentification3": { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, "GenericIdentification30": { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, "GenericOrganisationIdentification1": { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, "GenericOrganisationIdentification3": { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, "GenericPersonIdentification1": { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, "GenericPersonIdentification2": { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, "GetPartiesError_IdentificationVerificationReportV03": { "title": "GetPartiesError_IdentificationVerificationReportV03", "type": "object", "additionalProperties": false, "properties": { "Assgnmt": { "allOf": [ { "title": "IdentificationAssignment3", "type": "object", "additionalProperties": false, "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, "Assgnr": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, "Assgne": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" } ] } }, "required": [ "MsgId", "CreDtTm", "Assgnr", "Assgne" ], "example": { "MsgId": 123, "CreDtTm": "2020-01-01T00:00:00Z", "Assgnr": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "Assgne": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } } } }, { "description": "Assignment\nInformation related to the identification assignment.\n" } ] }, "Rpt": { "allOf": [ { "title": "VerificationReport4", "type": "object", "additionalProperties": false, "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", "properties": { "OrgnlId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" } ] }, "Vrfctn": { "allOf": [ { "title": "IdentificationVerificationIndicator", "type": "boolean", "example": true, "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" }, { "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" } ] }, "Rsn": { "allOf": [ { "title": "VerificationReason1Choice", "type": "object", "additionalProperties": false, "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalVerificationReason1Code", "description": "Specifies the external verification reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" } ] }, "OrgnlPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" } ] }, "UpdtdPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" } ] } }, "required": [ "OrgnlId", "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, "Vrfctn": true, "OrgnlPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } }, "UpdtdPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } } } }, { "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ "Assgnmt", "Rpt" ], "example": { "Assgnmt": { "Id": 123, "CreDtTm": "2013-03-07T16:30:00", "Assgnr": { "Id": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, "Assgne": { "Id": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } } }, "Rpt": { "Id": 123, "CreDtTm": "2013-03-07T16:30:00", "RptgPty": { "Id": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, "RptdPty": { "Id": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, "RptdDoc": { "Nb": 123, "RltdDt": "2013-03-07", "RltdDtTp": { "Cd": 123 } }, "Rsn": { "Cd": 123, "Prtry": 123 } }, "SplmtryData": { "PlcAndNm": 123, "Envlp": 123, "RltdDt": "2013-03-07", "RltdDtTp": { "Cd": 123 } } } }, "GetParties_IdentificationVerificationReportV03": { "title": "GetParties_IdentificationVerificationReportV03", "type": "object", "additionalProperties": false, "properties": { "Assgnmt": { "allOf": [ { "title": "IdentificationAssignment3", "type": "object", "additionalProperties": false, "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, "Assgnr": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, "Assgne": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" } ] } }, "required": [ "MsgId", "CreDtTm", "Assgnr", "Assgne" ], "example": { "MsgId": 123, "CreDtTm": "2020-01-01T00:00:00Z", "Assgnr": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "Assgne": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } } } }, { "description": "Assignment\nIdentifies the identification assignment.\n" } ] }, "Rpt": { "allOf": [ { "title": "VerificationReport4", "type": "object", "additionalProperties": false, "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", "properties": { "OrgnlId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" } ] }, "Vrfctn": { "allOf": [ { "title": "IdentificationVerificationIndicator", "type": "boolean", "example": true, "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" }, { "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" } ] }, "Rsn": { "allOf": [ { "title": "VerificationReason1Choice", "type": "object", "additionalProperties": false, "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalVerificationReason1Code", "description": "Specifies the external verification reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" } ] }, "OrgnlPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" } ] }, "UpdtdPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" } ] } }, "required": [ "OrgnlId", "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, "Vrfctn": true, "OrgnlPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } }, "UpdtdPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } } } }, { "description": "Report\nInformation concerning the verification of the identification data for which verification was requested.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "SupplementaryData\nAdditional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ "Assgnmt", "Rpt" ], "example": { "Assgnmt": { "MsgId": 123, "CreDtTm": "2020-01-01T00:00:00Z", "Assgnr": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "Assgne": { "OrgId": { "Othr": { "Id": "DFSPID" } } } }, "Rpt": { "OrgnlId": 12345678, "Vrfctn": true, "UpdtdPtyAndAcctId": { "Pty": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 18761231234 }, "SchmeNm": { "Prtry": "MSISDN" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } } } } }, "GroupHeader113": { "title": "GroupHeader113", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "TtlIntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Total Interbank Settlement Amount\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "Payment Type Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "TtlIntrBkSttlmAmt": { "Ccy": "EUR", "Value": 100 }, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": "BE71096123456769" }, "Ccy": "EUR" }, "SttlmAcctOwnr": { "Nm": "Name" }, "SttlmAcctSvcr": { "Nm": "Name" }, "SttlmAgt": { "FinInstnId": { "BICFI": "BIC" } } }, "PmtTpInf": { "InstrPrty": "NORM", "CtgyPurp": "CASH" } } }, "GroupHeader120": { "title": "GroupHeader120", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the message was created.\n" } ] } }, "required": [ "MsgId", "CreDtTm" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z" } }, "GroupHeader129": { "title": "GroupHeader129", "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "PmtInstrXpryDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Payment Instruction Expiry Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } } }, "IBAN2007Identifier": { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, "ISODate": { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, "ISODateTime": { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, "ISOYear": { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, "IdentificationAssignment3": { "title": "IdentificationAssignment3", "type": "object", "additionalProperties": false, "description": "IdentificationAssignment\nInformation that unambiguously identifies a message, as assigned by the assignor to the assignee.\n", "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nUnique identification, as assigned by the assigner, to unambiguously identify the message.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the identification assignment was created.\n" } ] }, "Assgnr": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignor\nParty that assigns the identification assignment to another party. This is also the sender of the message.\n" } ] }, "Assgne": { "allOf": [ { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, { "description": "Assignee\nParty that the identification assignment is assigned to. This is also the receiver of the message.\n" } ] } }, "required": [ "MsgId", "CreDtTm", "Assgnr", "Assgne" ], "example": { "MsgId": 123, "CreDtTm": "2020-01-01T00:00:00Z", "Assgnr": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "Assgne": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } } } }, "IdentificationInformation4": { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, "IdentificationVerificationIndicator": { "title": "IdentificationVerificationIndicator", "type": "boolean", "example": true, "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" }, "Instruction4Code": { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, "InstructionForCreditorAgent3": { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, "InstructionForCreditorAgent3_FX_Quotes": { "title": "InstructionForCreditorAgent3_Put_FX_Quotes_ID", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "AmountTypeEnum", "description": "NOTE: This pattern is not the original ISO20022 specification.\n This represents the enum values when mapping to and from FSPIOP specification.\n", "type": "string", "enum": [ "SEND", "RECEIVE" ], "example": "SEND" }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, "InstructionForNextAgent1": { "title": "InstructionForNextAgent1", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, "LEIIdentifier": { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, "LocalInstrument2Choice": { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, "Max105Text": { "title": "Max105Text", "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, "maxLength": 105, "example": 12345 }, "Max10Text": { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, "Max128Text": { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, "Max140Text": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Max15NumericText": { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, "Max16Text": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Max2048Text": { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, "Max256Text": { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, "Max34Text": { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, "Max350Text": { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, "Max35Text": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Max4Text": { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, "Max70Text": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "NamePrefix2Code": { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, "Number": { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, "OrganisationIdentification29": { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "OrganisationIdentification39": { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, "OrganisationIdentificationSchemeName1Choice": { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, "OtherContact1": { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, "PacsError_FIToFIPaymentStatusReportV15": { "title": "PacsError_FIToFIPaymentStatusReportV15", "type": "object", "additionalProperties": false, "description": "This message is sent by an account servicing institution to an account owner. It is used to inform the account owner about the status of a payment initiation.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader120", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the message was created.\n" } ] } }, "required": [ "MsgId", "CreDtTm" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z" } }, { "description": "Set of characteristics shared by all individual transactions included in the message.\n" } ] }, "TxInfAndSts": { "allOf": [ { "title": "PaymentTransaction163", "description": "Provides further details on the original transactions, to which the status report message refers.\n", "type": "object", "additionalProperties": false, "properties": { "StsId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" } ] }, "OrgnlInstrId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" } ] }, "OrgnlEndToEndId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" } ] }, "OrgnlTxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" } ] }, "OrgnlUETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" } ] }, "TxSts": { "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": "COMM", "enum": [ "COMM", "RESV", "RECV", "ABOR" ] }, { "description": "Specifies the status of the transaction.\n" } ] }, "StsRsnInf": { "allOf": [ { "title": "StatusReasonInformation14", "description": "Unsure on description.\n", "type": "object", "additionalProperties": false, "properties": { "Orgtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Originator\nParty that issues the status.\n" } ] }, "Rsn": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, "AddtlInf": { "allOf": [ { "title": "Max105Text", "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, "maxLength": 105, "example": 12345 }, { "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, "example": { "Orgtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "SubDepartment", "StrtNm": "StreetName", "BldgNb": "BuildingNumber", "PstCd": "PostCode", "TwnNm": "TownName", "CtrySubDvsn": "CountrySubDivision", "Ctry": "Country" } }, "Rsn": { "Cd": "AGNT" }, "AddtlInf": "AdditionalInformation" } }, { "description": "Information concerning the reason for the status.\n" } ] }, "AccptncDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Date and time at which the status was accepted.\n" } ] }, "AcctSvcrRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" } ] }, "ExctnConf": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] }, "PrcgDt": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\nSpecified date.\n" } ] } }, "required": [ "Dt" ] }, { "properties": { "DtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "DateTime\nSpecified date and time.\n" } ] } }, "required": [ "DtTm" ] } ], "example": { "DtTm": "2020-01-01T00:00:00Z" } }, { "description": "Date/time at which the instruction was processed by the specified party.\n" } ] } }, "example": { "StsId": 12345, "OrgnlInstrId": 12345, "OrgnlEndToEndId": 12345, "OrgnlTxId": 12345, "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", "TxSts": "RJCT", "StsRsnInf": { "Rsn": "RSN", "AddtlInf": "ADDITIONAL" }, "AccptncDtTm": "2020-01-01T00:00:00Z", "AcctSvcrRef": "ACCTSVCRREF", "ClrSysRef": "CLRSYSREF", "ExctnConf": "1234567890ABCDEF", "SplmtryData": { "PlcAndNm": "PLACE", "Envlp": "ENVELOPE" } } }, { "description": "Information concerning the original transactions, to which the status report message refers.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ "GrpHdr" ], "example": { "GrpHdr": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmDt": "2020-01-01" }, "InstgAgt": { "FinInstnId": { "BICFI": "BICFI" } }, "InstdAgt": { "FinInstnId": { "BICFI": "BICFI" } } }, "TxInfAndSts": { "OrgnlInstrId": 12345, "OrgnlEndToEndId": 12345, "TxSts": "RJCT", "StsRsnInf": { "Rsn": "RSN", "AddtlInf": "ADDITIONAL" } }, "SplmtryData": { "PlcAndNm": "PLACE", "Envlp": "ENVELOPE" } } }, "PacsStatus_FIToFIPaymentStatusReportV15": { "title": "PacsStatus_FIToFIPaymentStatusReportV15", "description": "The PacsStatus message is sent by a financial institution to another financial institution as a response to the FIToFIPaymentStatusReport message. The message provides information on the status of a payment instruction and its underlying individual transactions.", "type": "object", "additionalProperties": false, "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader120", "description": "Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MessageIdentification\nDefinition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.\nUsage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "CreationDateTime\nDate and time at which the message was created.\n" } ] } }, "required": [ "MsgId", "CreDtTm" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z" } }, { "description": "Set of characteristics shared by all individual transactions included in the message.\n" } ] }, "TxInfAndSts": { "allOf": [ { "title": "PaymentTransaction163", "description": "Provides further details on the original transactions, to which the status report message refers.\n", "type": "object", "additionalProperties": false, "properties": { "StsId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" } ] }, "OrgnlInstrId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" } ] }, "OrgnlEndToEndId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" } ] }, "OrgnlTxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" } ] }, "OrgnlUETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" } ] }, "TxSts": { "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": "COMM", "enum": [ "COMM", "RESV", "RECV", "ABOR" ] }, { "description": "Specifies the status of the transaction.\n" } ] }, "StsRsnInf": { "allOf": [ { "title": "StatusReasonInformation14", "description": "Unsure on description.\n", "type": "object", "additionalProperties": false, "properties": { "Orgtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Originator\nParty that issues the status.\n" } ] }, "Rsn": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, "AddtlInf": { "allOf": [ { "title": "Max105Text", "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, "maxLength": 105, "example": 12345 }, { "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, "example": { "Orgtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "SubDepartment", "StrtNm": "StreetName", "BldgNb": "BuildingNumber", "PstCd": "PostCode", "TwnNm": "TownName", "CtrySubDvsn": "CountrySubDivision", "Ctry": "Country" } }, "Rsn": { "Cd": "AGNT" }, "AddtlInf": "AdditionalInformation" } }, { "description": "Information concerning the reason for the status.\n" } ] }, "AccptncDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Date and time at which the status was accepted.\n" } ] }, "AcctSvcrRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" } ] }, "ExctnConf": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] }, "PrcgDt": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\nSpecified date.\n" } ] } }, "required": [ "Dt" ] }, { "properties": { "DtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "DateTime\nSpecified date and time.\n" } ] } }, "required": [ "DtTm" ] } ], "example": { "DtTm": "2020-01-01T00:00:00Z" } }, { "description": "Date/time at which the instruction was processed by the specified party.\n" } ] } }, "example": { "StsId": 12345, "OrgnlInstrId": 12345, "OrgnlEndToEndId": 12345, "OrgnlTxId": 12345, "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", "TxSts": "RJCT", "StsRsnInf": { "Rsn": "RSN", "AddtlInf": "ADDITIONAL" }, "AccptncDtTm": "2020-01-01T00:00:00Z", "AcctSvcrRef": "ACCTSVCRREF", "ClrSysRef": "CLRSYSREF", "ExctnConf": "1234567890ABCDEF", "SplmtryData": { "PlcAndNm": "PLACE", "Envlp": "ENVELOPE" } } }, { "description": "Information concerning the original transactions, to which the status report message refers.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] } }, "required": [ "GrpHdr" ], "example": { "GrpHdr": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "TxInfAndSts": { "StsId": 12345, "OrgnlInstrId": 12345, "OrgnlEndToEndId": 12345, "OrgnlTxId": 12345, "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", "TxSts": "RJCT", "StsRsnInf": { "Rsn": "RSN", "AddtlInf": "ADDITIONAL" }, "AccptncDtTm": "2020-01-01T00:00:00Z", "AcctSvcrRef": "ACCTSVCRREF", "ClrSysRef": "CLRSYSREF", "ExctnConf": "1234567890ABCDEF", "SplmtryData": { "PlcAndNm": "PLACE", "Envlp": "ENVELOPE" } } } } }, "Party38Choice": { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, "Party40Choice": { "title": "Party40Choice", "description": "Identification of a person, an organisation or a financial institution.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nIdentification of a person or an organisation.\n" } ] } }, "required": [ "Pty" ] }, { "properties": { "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nIdentification of a financial institution.\n" } ] } }, "required": [ "Agt" ] } ], "example": { "Pty": { "Nm": "Name", "PstlAdr": { "Ctry": "US", "AdrLine": [ "Line1", "Line2" ] }, "Id": { "OrgId": { "AnyBIC": "BIC" } } }, "Agt": { "FinInstnId": { "BICFI": "BUKBGB22" }, "BrnchId": { "Id": 12345, "Nm": "Oxford Street Branch", "PstlAdr": { "Ctry": "GB", "AdrLine": [ "1 Oxford Street", "London", "UK" ] } } } } }, "Party52Choice": { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, "PartyIdentification135": { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, "PartyIdentification272": { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, "PaymentIdentification13": { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, "PaymentTransaction163": { "title": "PaymentTransaction163", "description": "Provides further details on the original transactions, to which the status report message refers.\n", "type": "object", "additionalProperties": false, "properties": { "StsId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to unambiguously identify the status report.\n" } ] }, "OrgnlInstrId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original instruction.\n\n(FSPIOP equivalent: transactionRequestId)\n" } ] }, "OrgnlEndToEndId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original end-to-end transaction.\n\n(FSPIOP equivalent: transactionId)\n" } ] }, "OrgnlTxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique identification, as assigned by the original sending party, to\nunambiguously identify the original transaction.\n\n(FSPIOP equivalent: quoteId)\n" } ] }, "OrgnlUETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "Unique end-to-end transaction reference, as assigned by the original sending party, to unambiguously identify the original transaction.\n" } ] }, "TxSts": { "allOf": [ { "title": "ExternalPaymentTransactionStatus1Code", "description": "Specifies the external payment transaction status code.\n\nFor FSPIOP transfer state enumeration mappings:\n{\n \"COMM\": \"COMMITED\",\n \"RESV\": \"RESERVED\",\n \"RECV\": \"RECEIVED\",\n \"ABOR\": \"ABORTED\"\n}\n\nNOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": "COMM", "enum": [ "COMM", "RESV", "RECV", "ABOR" ] }, { "description": "Specifies the status of the transaction.\n" } ] }, "StsRsnInf": { "allOf": [ { "title": "StatusReasonInformation14", "description": "Unsure on description.\n", "type": "object", "additionalProperties": false, "properties": { "Orgtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Originator\nParty that issues the status.\n" } ] }, "Rsn": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, "AddtlInf": { "allOf": [ { "title": "Max105Text", "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, "maxLength": 105, "example": 12345 }, { "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, "example": { "Orgtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "SubDepartment", "StrtNm": "StreetName", "BldgNb": "BuildingNumber", "PstCd": "PostCode", "TwnNm": "TownName", "CtrySubDvsn": "CountrySubDivision", "Ctry": "Country" } }, "Rsn": { "Cd": "AGNT" }, "AddtlInf": "AdditionalInformation" } }, { "description": "Information concerning the reason for the status.\n" } ] }, "AccptncDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Date and time at which the status was accepted.\n" } ] }, "AcctSvcrRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the status report.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Reference that is assigned by the account servicing institution and sent to the account owner to unambiguously identify the transaction.\n" } ] }, "ExctnConf": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "Unique reference, as assigned by the account servicing institution, to unambiguously identify the confirmation.\n" } ] }, "SplmtryData": { "allOf": [ { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, { "description": "Additional information that cannot be captured in the structured elements and/or any other specific block.\n" } ] }, "PrcgDt": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\nSpecified date.\n" } ] } }, "required": [ "Dt" ] }, { "properties": { "DtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "DateTime\nSpecified date and time.\n" } ] } }, "required": [ "DtTm" ] } ], "example": { "DtTm": "2020-01-01T00:00:00Z" } }, { "description": "Date/time at which the instruction was processed by the specified party.\n" } ] } }, "example": { "StsId": 12345, "OrgnlInstrId": 12345, "OrgnlEndToEndId": 12345, "OrgnlTxId": 12345, "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", "TxSts": "RJCT", "StsRsnInf": { "Rsn": "RSN", "AddtlInf": "ADDITIONAL" }, "AccptncDtTm": "2020-01-01T00:00:00Z", "AcctSvcrRef": "ACCTSVCRREF", "ClrSysRef": "CLRSYSREF", "ExctnConf": "1234567890ABCDEF", "SplmtryData": { "PlcAndNm": "PLACE", "Envlp": "ENVELOPE" } } }, "PaymentTypeInformation28": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, "PercentageRate": { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, "PersonIdentification13": { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, "PersonIdentification18": { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, "PersonIdentificationSchemeName1Choice": { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, "PhoneNumber": { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, "PostalAddress24": { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, "PostalAddress27": { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, "PreferredContactMethod1Code": { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, "PreferredContactMethod2Code": { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, "Priority2Code": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ProxyAccountIdentification1": { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, "ProxyAccountType1Choice": { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, "Purpose2Choice": { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, "RegulatoryAuthority2": { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, "RegulatoryReporting3": { "title": "RegulatoryReporting3", "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "DbtCdtRptgInd": { "allOf": [ { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, { "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" } ] }, "Authrty": { "allOf": [ { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, { "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, "Dtls": { "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", "anyOf": [ { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, { "items": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "type": "array" } ] } }, "example": { "DbtCdtRptgInd": "CRED", "Authrty": { "Nm": "Swiss National Bank", "Ctry": "CH" }, "Dtls": { "Cd": "A1", "Inf": "Mandatory regulatory information" } } }, "RegulatoryReportingType1Code": { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, "ServiceLevel8Choice": { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, "SettlementInstruction15": { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, "SettlementMethod1Code": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "StatusReason6Choice": { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, "StatusReasonInformation14": { "title": "StatusReasonInformation14", "description": "Unsure on description.\n", "type": "object", "additionalProperties": false, "properties": { "Orgtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Originator\nParty that issues the status.\n" } ] }, "Rsn": { "allOf": [ { "title": "StatusReason6Choice", "description": "Specifies the reason for the status.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalStatusReason1Code", "description": "Specifies the external status reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason for the status, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason for the status, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason for the status report.\n" } ] }, "AddtlInf": { "allOf": [ { "title": "Max105Text", "description": "Specifies a character string with a maximum length of 105 characters.\n", "type": "string", "minLength": 1, "maxLength": 105, "example": 12345 }, { "description": "AdditionalInformation\nAdditional information about the status report.\n" } ] } }, "example": { "Orgtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "SubDepartment", "StrtNm": "StreetName", "BldgNb": "BuildingNumber", "PstCd": "PostCode", "TwnNm": "TownName", "CtrySubDvsn": "CountrySubDivision", "Ctry": "Country" } }, "Rsn": { "Cd": "AGNT" }, "AddtlInf": "AdditionalInformation" } }, "StructuredRegulatoryReporting3": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "SupplementaryData1": { "title": "SupplementaryData1", "description": "Additional information that cannot be captured in the structured fields and/or any other specific block.\n", "type": "object", "additionalProperties": false, "properties": { "PlcAndNm": { "allOf": [ { "title": "Max350Text", "description": "Specifies a character string with a maximum length of 350 characters.\n", "type": "string", "minLength": 1, "maxLength": 350, "example": 350 }, { "description": "PlaceAndName\nUnambiguous reference to the location where the supplementary data must be inserted in the message instance.\n" } ] }, "Envlp": { "allOf": [ { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, { "description": "Envelope\nTechnical element wrapping the supplementary data.\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n" } ] } }, "required": [ "Envlp" ], "example": { "PlcAndNm": "Additional information", "Envlp": { "Cd": "CH03", "Prtry": "Additional information" } } }, "SupplementaryDataEnvelope1": { "title": "SupplementaryDataEnvelope1", "description": "SupplementaryDataEnvelope1\nTechnical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.\n", "type": "object", "additionalProperties": false }, "TaxAmount3": { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, "TaxAuthorisation1": { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, "TaxData1": { "title": "TaxData1", "description": "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.\n", "type": "object", "additionalProperties": false, "properties": { "Cdtr": { "allOf": [ { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, { "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, "Dbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, "UltmtDbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, "AdmstnZone": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" } ] }, "RefNb": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, "Mtd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, "TtlTaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate by which tax is due.\n" } ] }, "SeqNb": { "allOf": [ { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, "Rcrd": { "description": "Record\n\nDetails of the tax record.\n", "anyOf": [ { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, { "items": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "type": "array" } ] } }, "example": { "Cdtr": { "Titl": "Mr", "Nm": "John Doe" }, "Dbtr": { "Titl": "Mr", "Nm": "John Doe" }, "UltmtDbtr": { "Titl": "Mr", "Nm": "John Doe" }, "AdmstnZone": "CH", "RefNb": 12345, "Mtd": "A", "TtlTaxblBaseAmt": { "Ccy": "CHF", "Amt": 1000 }, "TtlTaxAmt": { "Ccy": "CHF", "Amt": 100 }, "Dt": "2018-01-01", "SeqNb": 1, "Rcrd": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, "TaxParty1": { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, "TaxParty2": { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, "TaxPeriod3": { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, "TaxRecord3": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "TaxRecordDetails3": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "TaxRecordPeriod1Code": { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, "TermsRequest_FIToFICustomerCreditProposal": { "title": "TermsRequest_FIToFICustomerCreditProposal", "type": "object", "additionalProperties": false, "description": "This message is sent by a financial institution to a financial institution to propose the terms of a credit to a customer.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader129", "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "PmtInstrXpryDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Payment Instruction Expiry Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } } }, { "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction67", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "XchgRate": { "allOf": [ { "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", "example": 0.7, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" } ] }, "ChrgBr": { "title": "ChargeBearerType1Code", "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", "SHAR" ], "example": "DEBT" }, "ChrgsInf": { "allOf": [ { "title": "Charges16", "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", "type": "object", "additionalProperties": false, "properties": { "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, "Tp": { "allOf": [ { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ "Amt", "Agt" ], "example": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } } }, { "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "InstrForNxtAgt": { "allOf": [ { "title": "InstructionForNextAgent1", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "RgltryRptg": { "allOf": [ { "title": "RegulatoryReporting3", "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "DbtCdtRptgInd": { "allOf": [ { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, { "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" } ] }, "Authrty": { "allOf": [ { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, { "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, "Dtls": { "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", "anyOf": [ { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, { "items": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "type": "array" } ] } }, "example": { "DbtCdtRptgInd": "CRED", "Authrty": { "Nm": "Swiss National Bank", "Ctry": "CH" }, "Dtls": { "Cd": "A1", "Inf": "Mandatory regulatory information" } } }, { "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, "Tax": { "allOf": [ { "title": "TaxData1", "description": "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.\n", "type": "object", "additionalProperties": false, "properties": { "Cdtr": { "allOf": [ { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, { "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, "Dbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, "UltmtDbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, "AdmstnZone": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" } ] }, "RefNb": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, "Mtd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, "TtlTaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate by which tax is due.\n" } ] }, "SeqNb": { "allOf": [ { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, "Rcrd": { "description": "Record\n\nDetails of the tax record.\n", "anyOf": [ { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, { "items": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "type": "array" } ] } }, "example": { "Cdtr": { "Titl": "Mr", "Nm": "John Doe" }, "Dbtr": { "Titl": "Mr", "Nm": "John Doe" }, "UltmtDbtr": { "Titl": "Mr", "Nm": "John Doe" }, "AdmstnZone": "CH", "RefNb": 12345, "Mtd": "A", "TtlTaxblBaseAmt": { "Ccy": "CHF", "Amt": 1000 }, "TtlTaxAmt": { "Ccy": "CHF", "Amt": 100 }, "Dt": "2018-01-01", "SeqNb": 1, "Rcrd": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "Tax\nProvides details on the tax.\n" } ] }, "VrfctnOfTerms": { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } } }, "required": [ "PmtId", "IntrBkSttlmAmt", "ChrgBr", "Dbtr", "DbtrAgt", "CdtrAgt", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" }, "SeqTp": "SEQTP" }, "IntrBkSttlmAmt": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" }, "InstdAmt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "XchgRate": 123.45, "ChrgBr": "SHAR", "ChrgsInf": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } }, "Dbtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "CODE" }, "InstrForNxtAgt": { "Cd": "CODE" }, "Purp": { "Cd": "CASH" }, "RgltryRptg": { "Dbtr": true, "Cdtr": true }, "Tax": "Cdtr" } }, { "description": "Credit Transfer Transaction Information\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": 123456789, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "CtrlSum": 100, "InitgPty": { "Nm": "Initiating Party Name", "Id": { "OrgId": { "Othr": [ { "Id": 123456789, "SchmeNm": { "Cd": "BBA", "Prtry": "Party Identification Scheme Name" } } ] } } }, "FwdgAgt": { "FinInstnId": { "BICFI": "BBBBBBBB" } } } } }, "TermsResponse_FIToFICustomerCreditConfirmation": { "title": "TermsResponse_FIToFICustomerCreditConfirmation", "type": "object", "additionalProperties": false, "description": "This message is sent by the initiating party to the executing party, directly or through one or more intermediaries, to confirm the credit transfer transaction.\n", "properties": { "GrpHdr": { "allOf": [ { "title": "GroupHeader129", "description": "Group Header Set of characteristics shared by all individual transactions included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "MsgId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Message Identification\n" } ] }, "CreDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Creation Date and Time\n" } ] }, "PmtInstrXpryDtTm": { "allOf": [ { "title": "ISODateTime", "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", "type": "string", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:(\\.\\d{3}))(?:Z|[+-][01]\\d:[0-5]\\d)$", "example": "2013-03-07T14:44:30.000Z" }, { "description": "Payment Instruction Expiry Date and Time\n" } ] }, "NbOfTxs": { "allOf": [ { "title": "Max15NumericText", "description": "Specifies a numeric string with a maximum length of 15 digits.\n", "type": "string", "pattern": "^[0-9]{1,15}$", "example": 123456789012345 }, { "description": "Number of Transactions\n" } ] }, "SttlmInf": { "allOf": [ { "title": "SettlementInstruction15", "description": "Specifies the details on how the settlement of the original transaction(s) between the\ninstructing agent and the instructed agent was completed.\n", "type": "object", "additionalProperties": false, "properties": { "SttlmMtd": { "title": "SettlementMethod1Code", "description": "Specifies the method used to settle the credit transfer instruction.\n\nINDA: Indirect Account\nINGA: Indirect Agent\nCOVE: Cover\nCLRG: Clearing\n", "type": "string", "enum": [ "INDA", "INGA", "COVE", "CLRG" ], "example": "CLRG" }, "PmtTpInf": { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } } }, "required": [ "SttlmMtd" ], "example": { "SttlmMtd": "INDA", "PmtTpInf": { "InstrPrty": "NORM", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CH03" }, "CtgyPurp": { "Cd": "SUPP" }, "Cdtr": { "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "AdrLine": "Address", "Ctry": "CH" }, "Id": { "OrgId": { "AnyBIC": "BIC", "Othr": { "Id": 123, "SchmeNm": { "Cd": "IBAN", "Issr": "BIC" } } } }, "CtryOfRes": "CH", "CtctDtls": { "Nm": "Name", "PhneNb": 123, "EmailAdr": null } } } } }, { "description": "Settlement Information\n" } ] } }, "required": [ "MsgId", "CreDtTm", "NbOfTxs", "SttlmInf" ], "example": { "MsgId": 12345, "CreDtTm": "2020-01-01T00:00:00Z", "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "SttlmInf": { "SttlmMtd": "INDA", "SttlmAcct": { "Id": { "IBAN": 123 } }, "SttlmAcctOwnr": { "Nm": "John Doe" }, "SttlmAcctSvcr": { "BICFI": 123 } } } }, { "description": "Group Header\nSet of characteristics shared by all individual transactions included in the message.\n" } ] }, "CdtTrfTxInf": { "allOf": [ { "title": "CreditTransferTransaction67", "description": "Provides further details specific to the individual transaction(s) included in the message.\n", "type": "object", "additionalProperties": false, "properties": { "PmtId": { "allOf": [ { "title": "PaymentIdentification13", "description": "Provides further means of referencing a payment transaction.\n", "type": "object", "additionalProperties": false, "properties": { "InstrId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "InstructionIdentification (FSPIOP equivalent: transactionRequestId)\n\nDefinition: Unique identification, as assigned by an instructing party for an instructed party, to\nunambiguously identify the instruction.\n\nUsage: The instruction identification is a point to point reference that can be used between the\ninstructing party and the instructed party to refer to the individual instruction. It can be included in\nseveral messages related to the instruction.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "EndToEndId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "EndToEndIdentification (FSPIOP equivalent: transactionId)\n\nDefinition: Unique identification, as assigned by the initiating party, to unambiguously identify the\ntransaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.\n\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the\ntransaction. It can be included in several messages related to the transaction.\n\nUsage: In case there are technical limitations to pass on multiple references, the end-to-end\nidentification must be passed on throughout the entire end-to-end chain.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "TxId": { "allOf": [ { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, { "description": "TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)\n\nDefinition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the\ntransaction that is passed on, unchanged, throughout the entire interbank chain.\n\nUsage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to\nthe transaction on the interbank level.\n\nUsage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.\n\nThis field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.\n" } ] }, "UETR": { "allOf": [ { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, { "description": "UETR\nUniversally unique identifier to provide an end-to-end reference of a payment transaction.\n" } ] }, "ClrSysRef": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ClearingSystemReference\nUnique reference, as assigned by a clearing system, to unambiguously identify the instruction.\n" } ] } }, "required": [ "TxId" ], "example": { "InstrId": "INSTRUCTIONID", "EndToEndId": "ENDTOENDID", "TxId": "TRANSACTIONID", "UETR": "123e4567-e89b-12d3-a456-426614174000", "ClrSysRef": "CLRSYSREF" } }, { "description": "PaymentIdentification\nSet of elements used to reference a payment instruction.\n" } ] }, "PmtTpInf": { "allOf": [ { "title": "PaymentTypeInformation28", "description": "Provides further details of the type of payment.\n", "type": "object", "additionalProperties": false, "properties": { "InstrPrty": { "title": "Priority2Code", "description": "Indicator of the urgency or order of importance that the instructing party\nwould like the instructed party to apply to the processing of the instruction.\n\nHIGH: High priority\nNORM: Normal priority\n", "type": "string", "enum": [ "HIGH", "NORM" ], "example": "HIGH" }, "ClrChanl": { "title": "ClearingChannel2Code", "description": "Specifies the clearing channel for the routing of the transaction, as part of\nthe payment type identification.\n\nRTGS: RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS: RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS: MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK: BookTransfer Payment through internal book transfer.\n", "type": "string", "enum": [ "RTGS", "RTNS", "MPNS", "BOOK" ], "example": "RTGS" }, "SvcLvl": { "allOf": [ { "title": "ServiceLevel8Choice", "description": "Details about a service level.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalServiceLevel1Code", "description": "Specifies the external service level code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nSpecifies a pre-agreed service or level of service between the parties, as published in an external service level code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies a pre-agreed service or level of service between the parties, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "SEPA" } }, { "description": "ServiceLevel\nAgreement under which or rules under which the transaction should be processed.\n" } ] }, "LclInstrm": { "allOf": [ { "title": "LocalInstrument2Choice", "type": "object", "additionalProperties": false, "description": "Specifies the local instrument, as published in an external local instrument code list or as a proprietary code.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalLocalInstrument1Code", "description": "Specifies the external local instrument identification code.", "type": "string", "minLength": 1, "maxLength": 35, "example": 12345 }, { "description": "Code\nSpecifies the local instrument, as published in an external local instrument code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nSpecifies the local instrument, as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "LocalInstrument\nDefinition: User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\n" } ] }, "CtgyPurp": { "allOf": [ { "title": "CategoryPurpose1Choice", "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", "maxLength": 4, "minLength": 1, "type": "string", "example": 1234 }, { "description": "Code\nCategory purpose, as published in an external category purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nCategory purpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "CategoryPurpose\nSpecifies the high level purpose of the instruction based on a set of pre-defined categories.\n" } ] } }, "example": { "InstrPrty": "NORM", "ClrChanl": "RTGS", "SvcLvl": { "Cd": "SEPA" }, "LclInstrm": { "Cd": "CORE" }, "CtgyPurp": { "Cd": "CASH" } } }, { "description": "PaymentTypeInformation\nSet of elements used to further specify the type of transaction.\n" } ] }, "UndrlygCstmrCdtTrf": { "allOf": [ { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, { "description": "Underlying Customer Credit Transfer\nTBD\n" } ] }, "IntrBkSttlmAmt": { "allOf": [ { "title": "ActiveCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveCurrencyAndAmount": { "allOf": [ { "title": "ActiveCurrencyAndAmount_SimpleType", "type": "string", "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$", "example": 123.45 } ] }, "Ccy": { "allOf": [ { "title": "ActiveCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveCurrencyAndAmount", "Ccy" ], "example": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InterbankSettlementAmount\nAmount of money moved between the instructing agent and the instructed agent.\n" } ] }, "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "XchgRate": { "allOf": [ { "title": "BaseOneRate", "type": "string", "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", "example": 0.7, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "ExchangeRate\nFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\n" } ] }, "ChrgBr": { "title": "ChargeBearerType1Code", "description": "Specifies which party(ies) will pay charges due for processing of the\ninstruction.\n\nDEBT: BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED: BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR: Shared In a credit transfer context, means that transaction charges on\n the sender side are to be borne by the debtor, transaction charges on the receiver side are to\n be borne by the creditor. In a direct debit context, means that transaction charges on the sender side\n are to be borne by the creditor, transaction charges on the receiver\n", "type": "string", "enum": [ "DEBT", "CRED", "SHAR" ], "example": "DEBT" }, "ChrgsInf": { "allOf": [ { "title": "Charges16", "description": "NOTE: Unsure on description.\n\nSeemingly a generic schema for charges, with an amount, agent, and type.\n", "type": "object", "additionalProperties": false, "properties": { "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\nTransaction charges to be paid by the charge bearer.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nAgent that takes the transaction charges or to which the transaction charges are due.\n" } ] }, "Tp": { "allOf": [ { "title": "ChargeType3Choice", "description": "ChargeType3Choice\nSpecifies the type of charge.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalChargeType1Code", "description": "Specifies the type of charge applied to the transaction.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCharge type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification3", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nName or number assigned by an entity to enable recognition of that entity, for example, account identifier.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "Issr": "BIC" } }, { "description": "Proprietary\nType of charge in a proprietary form, as defined by the issuer.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CASH" } }, { "description": "Type\nDefines the type of charges.\n" } ] } }, "required": [ "Amt", "Agt" ], "example": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } } }, { "description": "ChargesInformation\nProvides information on the charges to be paid by the charge bearer(s) related to the payment transaction.\n" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Debtor\nParty that owes an amount of money to the (ultimate) creditor.\n" } ] }, "DbtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "DebtorAccount\nUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "DebtorAgent\nFinancial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "CreditorAgent\nFinancial institution servicing an account for the creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Creditor\nParty to which an amount of money is due.\n" } ] }, "CdtrAcct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "CreditorAccount\nUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n" } ] }, "InstrForCdtrAgt": { "allOf": [ { "title": "InstructionForCreditorAgent3", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalCreditorAgentInstruction1Code", "description": "Specifies the instruction given by the creditor to the creditor agent.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForCreditorAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "InstrForNxtAgt": { "allOf": [ { "title": "InstructionForNextAgent1", "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "Instruction4Code", "description": "Specifies further instructions concerning the processing of a payment\ninstruction, provided by the sending clearing agent to the next agent(s).\n\nPHOA: PhoneNextAgent Please advise/contact next agent by phone.\nTELA: TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", "type": "string", "enum": [ "PHOA", "TELA" ], "example": "PHOA" }, { "description": "Code\nCoded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.\n" } ] }, "InstrInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "InstructionInformation\nFurther information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.\n" } ] } }, "example": { "Cd": "PHOA", "InstrInf": "Please advise/contact next agent by phone." } }, { "description": "InstructionForNextAgent\nSet of elements used to provide information on the remittance advice.\n" } ] }, "Purp": { "allOf": [ { "title": "Purpose2Choice", "description": "Specifies the underlying reason for the payment transaction.\n\nUsage: Purpose is used by the end-customers, that is initiating party,\n(ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose\nis a content element, which is not used for processing by any of the agents involved in the payment\nchain.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPurpose1Code", "description": "Specifies the external purpose code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\n\nUnderlying reason for the payment transaction, as published in an external purpose code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\n\nPurpose, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CH03" } }, { "description": "Purpose\nUnderlying reason for the payment transaction.\n" } ] }, "RgltryRptg": { "allOf": [ { "title": "RegulatoryReporting3", "description": "Information needed due to regulatory and/or statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "DbtCdtRptgInd": { "allOf": [ { "title": "RegulatoryReportingType1Code", "description": "Identifies whether the regulatory reporting information applies to the debit\nside, to the credit side or to both debit and credit sides of the transaction.\n\nCRED: Regulatory reporting applies to the credit side of the transaction.\nDEBT: Regulatory reporting applies to the debit side of the transaction.\nBOTH: Regulatory reporting applies to both debit and credit sides of the transaction.\n", "type": "string", "enum": [ "CRED", "DEBT", "BOTH" ], "example": "BOTH" }, { "description": "DebitCreditReportingIndicator\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n" } ] }, "Authrty": { "allOf": [ { "title": "RegulatoryAuthority2", "description": "Information about an entity requiring the regulatory reporting information.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the entity requiring the regulatory reporting information.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry of the entity that requires the regulatory reporting information.\n" } ] } }, "example": { "Nm": "Swiss National Bank", "Ctry": "CH" } }, { "description": "Authority\n\nEntity requiring the regulatory reporting information.\n" } ] }, "Dtls": { "description": "Details\nIdentifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", "anyOf": [ { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, { "items": { "title": "StructuredRegulatoryReporting3", "description": "StructuredRegulatoryReporting3\n\nInformation needed due to regulatory and statutory requirements.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nSpecifies the type of the information supplied in the regulatory reporting details.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate related to the specified type of regulatory reporting details.\n" } ] }, "Ctry": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country\n\nCountry related to the specified type of regulatory reporting details.\n" } ] }, "Cd": { "allOf": [ { "title": "Max10Text", "description": "Specifies a character string with a maximum length of 10 characters.\n", "type": "string", "minLength": 1, "maxLength": 10, "example": 1234567890 }, { "description": "Code\nSpecifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nAmount of money to be reported for regulatory and statutory requirements.\n" } ] }, "Inf": { "description": "Information\n\nAdditional details that cater for specific domestic regulatory requirements.\n", "anyOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "items": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "type": "array" } ] } }, "example": { "Tp": "T1", "Dt": "2018-01-01", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } }, "type": "array" } ] } }, "example": { "DbtCdtRptgInd": "CRED", "Authrty": { "Nm": "Swiss National Bank", "Ctry": "CH" }, "Dtls": { "Cd": "A1", "Inf": "Mandatory regulatory information" } } }, { "description": "RegulatoryReporting\nInformation needed due to regulatory and statutory requirements.\n" } ] }, "Tax": { "allOf": [ { "title": "TaxData1", "description": "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.\n", "type": "object", "additionalProperties": false, "properties": { "Cdtr": { "allOf": [ { "title": "TaxParty1", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the creditor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT" } }, { "description": "Creditor\n\nParty on the credit side of the transaction to which the tax applies.\n" } ] }, "Dbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "Debtor\n\nParty on the debit side of the transaction to which the tax applies.\n" } ] }, "UltmtDbtr": { "allOf": [ { "title": "TaxParty2", "description": "Details about the entity involved in the tax paid or to be paid.\n", "type": "object", "additionalProperties": false, "properties": { "TaxId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxIdentification\n\nTax identification number of the debtor.\n" } ] }, "RegnId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "RegistrationIdentification\n\nUnique identification, as assigned by an organisation, to unambiguously identify a party.\n" } ] }, "TaxTp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "TaxType\n\nType of tax payer.\n" } ] }, "Authstn": { "allOf": [ { "title": "TaxAuthorisation1", "description": "Details of an authorised tax paying party.\n", "type": "object", "additionalProperties": false, "properties": { "Titl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Title\n\nTitle or position of debtor or the debtor's authorised representative.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\n\nName of the debtor or the debtor's authorised representative.\n" } ] } }, "example": { "Titl": "Mr", "Nm": "John Doe" } }, { "description": "Authorisation\n\nDetails of the authorised tax paying party.\n" } ] } }, "example": { "TaxId": 123456789, "RegnId": 123456789, "TaxTp": "VAT", "Authstn": { "Titl": "Mr", "Nm": "John Doe" } } }, { "description": "UltimateDebtor\n\nUltimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.\n" } ] }, "AdmstnZone": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "AdministrationZone\n\nTerritorial part of a country to which the tax payment is related.\n" } ] }, "RefNb": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "ReferenceNumber\n\nTax reference information that is specific to a taxing agency.\n" } ] }, "Mtd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Method\n\nMethod used to indicate the underlying business or how the tax is paid.\n" } ] }, "TtlTaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxableBaseAmount\n\nTotal amount of money on which the tax is based.\n" } ] }, "TtlTaxAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalTaxAmount\n\nTotal amount of money as result of the calculation of the tax.\n" } ] }, "Dt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "Date\n\nDate by which tax is due.\n" } ] }, "SeqNb": { "allOf": [ { "title": "Number", "type": "string", "example": 256, "pattern": "^(?!0\\d)\\d{1,18}$" }, { "description": "SequenceNumber\n\nSequential number of the tax report.\n" } ] }, "Rcrd": { "description": "Record\n\nDetails of the tax record.\n", "anyOf": [ { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, { "items": { "title": "TaxRecord3", "description": "Set of elements used to define the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "AddtlInf": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "AdditionalInformation\n\nFurther details of the tax record.\n" } ] }, "CertId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CertificateIdentification\n\nIdentification number of the tax report as assigned by the taxing authority.\n" } ] }, "Ctgy": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Category\n\nSpecifies the tax code as published by the tax authority.\n" } ] }, "CtgyDtls": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CategoryDetails\n\nProvides further details of the category tax code.\n" } ] }, "DbtrSts": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "DebtorStatus\n\nCode provided by local authority to identify the status of the party that has drawn up the settlement document.\n" } ] }, "FrmsCd": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "FormsCode\n\nIdentifies, in a coded form, on which template the tax report is to be provided.\n" } ] }, "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "TaxAmt": { "allOf": [ { "title": "TaxAmount3", "description": "Information on the amount of the tax record.\n", "type": "object", "additionalProperties": false, "properties": { "Rate": { "allOf": [ { "title": "PercentageRate", "type": "string", "example": 1234, "pattern": "^(?!0\\d)(\\d{1,11}|\\d{1,10}.\\d{1}|\\d{1,9}.\\d{1,2}|\\d{1,8}.\\d{1,3}|\\d{1,7}.\\d{1,4}|\\d{1,6}.\\d{1,5}|\\d{1,5}.\\d{1,6}|\\d{1,4}.\\d{1,7}|\\d{1,3}.\\d{1,8}|\\d{1,2}.\\d{1,9}|\\d{1}.\\d{1,10})$" }, { "description": "Rate\n\nRate used to calculate the tax.\n" } ] }, "TaxblBaseAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TaxableBaseAmount\n\nAmount of money on which the tax is based.\n" } ] }, "TtlAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "TotalAmount\n\nTotal amount that is the result of the calculation of the tax for the record.\n" } ] }, "Dtls": { "description": "Details\n\nSet of elements used to provide details on the tax period and amount.\n", "anyOf": [ { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, { "items": { "title": "TaxRecordDetails3", "description": "Details on the tax period and amount.\n", "type": "object", "additionalProperties": false, "properties": { "Prd": { "allOf": [ { "title": "TaxPeriod3", "description": "Period of time details related to the tax payment.\n", "type": "object", "additionalProperties": false, "properties": { "FrToDt": { "allOf": [ { "title": "DatePeriod2", "description": "Range of time defined by a start date and an end date.\n", "type": "object", "additionalProperties": false, "properties": { "FrDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "FromDate\nStart date of the range.\n" } ] }, "ToDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "ToDate\nEnd date of the range.\n" } ] } }, "required": [ "FrDt", "ToDt" ], "example": { "FrDt": "2022-01-01", "ToDt": "2022-12-31" } }, { "description": "FromToDate\n\nRange of time between a start date and an end date for which the tax report is provided.\n" } ] }, "Tp": { "allOf": [ { "title": "TaxRecordPeriod1Code", "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 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" ], "example": "HLF1" }, { "description": "Type\n\nIdentification of the period related to the tax payment.\n" } ] }, "Yr": { "allOf": [ { "title": "ISOYear", "description": "Year represented by YYYY (ISO 8601).\n", "type": "string", "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", "example": 2019 }, { "description": "Year\n\nYear related to the tax payment.\n" } ] } }, "example": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } } }, { "description": "Period\n\nSet of elements used to provide details on the period of time related to the tax payment.\n" } ] }, "Amt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "Amount\n\nUnderlying tax amount related to the specified period.\n" } ] } }, "required": [ "Amt" ], "example": { "Prd": { "Yr": 2020, "Tp": "MM01", "FrToDt": { "FrDt": "2020-01-01", "ToDt": "2020-01-31" } }, "Amt": { "Amt": 100, "Ccy": "EUR" } } }, "type": "array" } ] } }, "example": { "Rate": 0, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 0 }, "TtlAmt": { "Ccy": "EUR", "Amt": 0 }, "Dtls": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "TaxAmount\n\nSet of elements used to provide information on the amount of the tax record.\n" } ] }, "Tp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Type\n\nHigh level code to identify the type of tax details.\n" } ] } }, "example": { "Tp": "VAT", "Ctgy": "A", "CtgyDtls": "Standard", "DbtrSts": "Resident", "CertId": 123456789, "FrmsCd": 123456789, "Prd": { "Yr": 2019, "Tp": "MM01", "FrToDt": { "FrDt": "2019-01-01", "ToDt": "2019-12-31" } }, "TaxAmt": { "Rate": 0.2, "TaxblBaseAmt": { "Ccy": "EUR", "Amt": 1000 }, "TtlAmt": { "Ccy": "EUR", "Amt": 200 } }, "AddtlInf": "VAT applicable" } }, "type": "array" } ] } }, "example": { "Cdtr": { "Titl": "Mr", "Nm": "John Doe" }, "Dbtr": { "Titl": "Mr", "Nm": "John Doe" }, "UltmtDbtr": { "Titl": "Mr", "Nm": "John Doe" }, "AdmstnZone": "CH", "RefNb": 12345, "Mtd": "A", "TtlTaxblBaseAmt": { "Ccy": "CHF", "Amt": 1000 }, "TtlTaxAmt": { "Ccy": "CHF", "Amt": 100 }, "Dt": "2018-01-01", "SeqNb": 1, "Rcrd": { "Tp": "T1", "Ctry": "CH", "Cd": "CHF", "Amt": { "Ccy": "CHF", "Amt": 1000 }, "Inf": 12345 } } }, { "description": "Tax\nProvides details on the tax.\n" } ] }, "VrfctnOfTerms": { "title": "CryptographicLockChoice", "description": "Cryptographically signed terms\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "IlpV4PrepPacket": { "allOf": [ { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" }, { "description": "Interledger Protocol packet (ILPv4) containing Cryptographically signed terms\n" } ] } }, "required": [ "IlpV4PrepPacket" ] }, { "properties": { "Sh256Sgntr": { "allOf": [ { "title": "Exact32HexBinaryText", "description": "Specifies a hexadecimal string.\n\nNOTE: This pattern is not the original ISO20022 specification.\n", "type": "string", "pattern": "^[A-Za-z0-9-_]{43}$", "maxLength": 48 }, { "description": "SHA-256 signature of the terms\n" } ] } }, "required": [ "Sh256Sgntr" ] } ], "example": { "IlpV4PrepPacket": "1234567890ABCDEF" } } }, "required": [ "PmtId", "IntrBkSttlmAmt", "ChrgBr", "Dbtr", "DbtrAgt", "CdtrAgt", "Cdtr" ], "example": { "PmtId": { "InstrId": "INSTRID", "EndToEndId": "ENDTOENDID" }, "PmtTpInf": { "LclInstrm": { "Cd": "CHQB", "Prtry": "PROPRIETARY" }, "SeqTp": "SEQTP" }, "IntrBkSttlmAmt": { "ActiveCurrencyAndAmount": 123.45, "Ccy": "USD" }, "InstdAmt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "XchgRate": 123.45, "ChrgBr": "SHAR", "ChrgsInf": { "Amt": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" }, "Agt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Tp": { "Cd": "SHAR" } }, "Dbtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "DbtrAcct": { "Id": { "IBAN": "IBAN" } }, "DbtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "CdtrAgt": { "BrnchId": { "Id": "BRANCHID" }, "FinInstnId": { "BICFI": "BICFI" } }, "Cdtr": { "Nm": "NAME", "PstlAdr": { "AdrTp": "ADDR", "BldgNb": "BLDGNB", "Ctry": "CTRY", "TwnNm": "TWNNM", "PstCd": "PSTCD", "StrtNm": "STRTNM" } }, "CdtrAcct": { "Id": { "IBAN": "IBAN" } }, "InstrForCdtrAgt": { "Cd": "CODE" }, "InstrForNxtAgt": { "Cd": "CODE" }, "Purp": { "Cd": "CASH" }, "RgltryRptg": { "Dbtr": true, "Cdtr": true }, "Tax": "Cdtr" } }, { "description": "Credit Transfer Transaction Information\nSet of elements providing information specific to the individual credit transfer(s).\n" } ] } }, "required": [ "GrpHdr", "CdtTrfTxInf" ], "example": { "GrpHdr": { "MsgId": 123456789, "CreDtTm": "2020-01-01T00:00:00Z", "NbOfTxs": 1, "CtrlSum": 100, "InitgPty": { "Nm": "Initiating Party Name", "Id": { "OrgId": { "Othr": [ { "Id": 123456789, "SchmeNm": { "Cd": "BBA", "Prtry": "Party Identification Scheme Name" } } ] } } }, "FwdgAgt": { "FinInstnId": { "BICFI": "BBBBBBBB" } } } } }, "ULIDIdentifier": { "title": "ULIDIdentifier", "type": "string", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "example": "01AN4Z07BY79KA1307SR9X4MV3" }, "UUIDv4Identifier": { "title": "UUIDv4Identifier", "type": "string", "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "UnderlyingCustomerCreditTransfer": { "title": "UnderlyingCustomerCreditTransfer", "type": "object", "additionalProperties": false, "properties": { "InstdAmt": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount", "type": "object", "additionalProperties": false, "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", "properties": { "ActiveOrHistoricCurrencyAndAmount": { "allOf": [ { "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", "type": "string", "example": 123.45, "pattern": "^(?!0\\d)(\\d{1,18}|\\d{1,17}.\\d{1}|\\d{1,16}.\\d{1,2}|\\d{1,15}.\\d{1,3}|\\d{1,14}.\\d{1,4}|\\d{1,13}.\\d{1,5})$" }, { "description": "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" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\n" } ] } }, "required": [ "ActiveOrHistoricCurrencyAndAmount", "Ccy" ], "example": { "ActiveOrHistoricCurrencyAndAmount": 123.45, "Ccy": "USD" } }, { "description": "InstructedAmount\nAmount 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" } ] }, "Dbtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party that owes an amount of money to the (ultimate) creditor.\n" } ] }, "Cdtr": { "allOf": [ { "title": "PartyIdentification272", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party52Choice", "description": "NOTE: Unsure on the description.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification39", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification3", "type": "object", "additionalProperties": false, "description": "Information related to an identification of an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification18", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification2", "type": "object", "additionalProperties": false, "description": "Identification of a person.", "properties": { "Id": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "Person\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous identification of a party.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "Country of Residence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact13", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nSpecifies the terms used to formally address a person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "URLAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "URLAddress\nAddress for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max256Text", "description": "Specifies a character string with a maximum length of 256 characters.\n", "type": "string", "minLength": 1, "maxLength": 256, "example": 256 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "OtherContact\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod2Code", "description": "Preferred method used to reach the individual contact within an organisation.\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "MAIL" }, { "description": "PreferredContactMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "URLAdr": "http://www.example.com", "EmailAdr": "example@example.com" } }, { "description": "Contact Details\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "PstCd": "PstCd", "TwnNm": "TwnNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry" }, "Id": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party to which an amount of money is due.\n" } ] }, "DbtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the debtor.\n" } ] }, "CdtrAgt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification8", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification23", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution or a branch of a financial institution.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData5", "description": "Information that locates and identifies a specific branch of a financial institution.\n", "type": "object", "additionalProperties": false, "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress27", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "CareOf": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "UnitNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "TwnLctnNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "DstrctNm": { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "CareOf": "CareOf", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "UnitNb": "UnitNb", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number" } } }, { "description": "BranchIdentification\nIdentifies a specific branch of a financial institution.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Financial institution servicing an account for the creditor.\n" } ] } }, "required": [ "Dbtr", "Cdtr", "DbtrAgt", "CdtrAgt" ] }, "VerificationReason1Choice": { "title": "VerificationReason1Choice", "type": "object", "additionalProperties": false, "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalVerificationReason1Code", "description": "Specifies the external verification reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, "VerificationReport4": { "title": "VerificationReport4", "type": "object", "additionalProperties": false, "description": "VerificationReport\nProvides information about the verification of party and/or account identification information.", "properties": { "OrgnlId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "OriginalIdentification\nUnique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.\n" } ] }, "Vrfctn": { "allOf": [ { "title": "IdentificationVerificationIndicator", "type": "boolean", "example": true, "description": "Definition: Identifies whether the party and/or account information received is correct.\n\n• Meaning When True: Indicates that the identification information received is correct.\n• Meaning When False: Indicates that the identification information received is incorrect\n" }, { "description": "Verification\nIdentifies whether the party and/or account information received is correct. Boolean value.\n" } ] }, "Rsn": { "allOf": [ { "title": "VerificationReason1Choice", "type": "object", "additionalProperties": false, "description": "Choice of format for the verification reason.\nOnly one, between the coded and the proprietary, can be chosen.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalVerificationReason1Code", "description": "Specifies the external verification reason code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nReason why the verified identification information is incorrect, as published in an external reason code list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nReason why the verified identification information is incorrect, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "AGNT" } }, { "description": "Reason\nSpecifies the reason why the verified identification information is incorrect.\n" } ] }, "OrgnlPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "OriginalPartyAndAccountIdentification\nProvides party and/or account identification information as given in the original message.\n" } ] }, "UpdtdPtyAndAcctId": { "allOf": [ { "title": "IdentificationInformation4", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific party or account.\n", "properties": { "Pty": { "allOf": [ { "title": "PartyIdentification135", "description": "Specifies the identification of a person or an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Id": { "allOf": [ { "title": "Party38Choice", "description": "Nature or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "OrgId": { "allOf": [ { "title": "OrganisationIdentification29", "description": "Unique and unambiguous way to identify an organisation.\n", "type": "object", "additionalProperties": false, "properties": { "AnyBIC": { "allOf": [ { "title": "AnyBICDec2014Identifier", "type": "string", "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "AnyBIC\nBusiness identification code of the organisation.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identification as an alternate identification for a party.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericOrganisationIdentification1", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies an organisation.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification for an organisation. FSPIOP equivalent to Party Identifier for an organisation in ISO 20022. Identification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "OrganisationIdentificationSchemeName1Choice", "description": "Choice of format for the organisation identification.\n", "type": "object", "additionalProperties": false, "properties": { "Cd": { "allOf": [ { "title": "ExternalOrganisationIdentification1Code", "description": "Specifies the external organisation identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] }, "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "anyOf": [ { "properties": { "Cd": {} } }, { "properties": { "Prtry": {} } } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an organisation, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "AnyBIC": "BICFI", "LEI": "529900T8BM49AURSDO55", "Othr": { "Id": 123, "SchmeNm": { "Cd": "BIC" }, "Issr": "BIC" } } }, { "description": "Organisation\nUnique and unambiguous way to identify an organisation.\n" } ] } }, "required": [ "OrgId" ] }, { "properties": { "PrvtId": { "allOf": [ { "title": "PersonIdentification13", "description": "Unique and unambiguous way to identify a person.\n", "type": "object", "additionalProperties": false, "properties": { "DtAndPlcOfBirth": { "allOf": [ { "title": "DateAndPlaceOfBirth1", "description": "Details about date and place of birth of a person.\n", "type": "object", "additionalProperties": false, "properties": { "BirthDt": { "allOf": [ { "title": "ISODate", "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", "type": "string", "format": "date", "example": "2013-03-07" }, { "description": "BirthDate\nDate on which a person was born.\n" } ] }, "PrvcOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "ProvinceOfBirth\nProvince where a person was born.\n" } ] }, "CityOfBirth": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "CityOfBirth\nCity where a person was born.\n" } ] }, "CtryOfBirth": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfBirth\nCountry where a person was born.\n" } ] } }, "required": [ "BirthDt", "CityOfBirth", "CtryOfBirth" ], "example": { "BirthDt": "1970-01-01", "PrvcOfBirth": "ON", "CityOfBirth": "Ottawa", "CtryOfBirth": "CA" } }, { "description": "DateAndPlaceOfBirth\nDate and place of birth of a person.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericPersonIdentification1", "type": "object", "additionalProperties": false, "description": "GenericPersonIdentification1\nInformation that locates and identifies a specific person.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "PersonIdentificationSchemeName1Choice", "description": "Sets of elements to identify a name of the identification scheme.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalPersonIdentification1Code", "description": "Specifies the external person identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CCPT" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "DRLC" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of a person, as assigned by an institution, using an identification scheme.\n" } ] } }, "example": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": "CUST", "Prtry": 1 } } } }, { "description": "PrivateIdentification\nUnique and unambiguous identification of a person, for example a passport.\n" } ] } }, "required": [ "PrvtId" ] } ], "example": { "OrgId": { "AnyBIC": "BIC" }, "PrvtId": { "DtAndPlcOfBirth": { "Dt": "2018-01-01", "CityOfBirth": "City" } } } }, { "description": "Identification\nUnique and unambiguous way to identify an organisation.\n" } ] }, "CtryOfRes": { "allOf": [ { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, { "description": "CountryOfResidence\nCountry 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" } ] }, "CtctDtls": { "allOf": [ { "title": "Contact4", "description": "Specifies the details of the contact person.\n", "type": "object", "additionalProperties": false, "properties": { "NmPrfx": { "allOf": [ { "description": "Specifies the terms used to formally address a person.\n\nDOCT: Doctor or Dr\nMADM: Madam\nMISS: Miss\nMIST: Mistress\nMIKS: Mx\n", "enum": [ "DOCT", "MADM", "MISS", "MIST", "MIKS" ], "type": "string", "example": "DOCT" }, { "description": "NamePrefix\nName prefix to be used before the name of the person.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which a party is known and which is usually used to identify that party.\n" } ] }, "PhneNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "PhoneNumber\nCollection of information that identifies a phone number, as defined by telecom services.\n" } ] }, "MobNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "MobilePhoneNumber\nCollection of information that identifies a mobile phone number, as defined by telecom services.\n" } ] }, "FaxNb": { "allOf": [ { "title": "PhoneNumber", "type": "string", "description": "Double check this regex.\n", "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" }, { "description": "FaxNumber\nCollection of information that identifies a fax number, as defined by telecom services.\n" } ] }, "EmailAdr": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "EmailAddress\nAddress for electronic mail (e-mail).\n" } ] }, "EmailPurp": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "EmailPurpose\nPurpose for which an email address may be used.\n" } ] }, "JobTitl": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "JobTitle\nTitle of the function.\n" } ] }, "Rspnsblty": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Responsibility\nRole of a person in an organisation.\n" } ] }, "Dept": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Department\nIdentification of a division of a large organisation or building.\n" } ] }, "Othr": { "allOf": [ { "title": "OtherContact1", "description": "Communication device number or electronic address used for communication.\n", "type": "object", "additionalProperties": false, "properties": { "ChanlTp": { "allOf": [ { "title": "Max4Text", "description": "Specifies a character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "ChannelType\nMethod used to contact the financial institution's contact for the specific tax region.\n" } ] }, "Id": { "allOf": [ { "title": "Max128Text", "description": "Specifies a character string with a maximum length of 128 characters.\n", "type": "string", "minLength": 1, "maxLength": 128, "example": 12345 }, { "description": "Identifier\nCommunication value such as phone number or email address.\n" } ] } }, "required": [ "ChanlTp" ], "example": { "ChanlTp": "PHON", "Id": 1234567890 } }, { "description": "Other\nContact details in another form.\n" } ] }, "PrefrdMtd": { "allOf": [ { "title": "PreferredContactMethod1Code", "description": "Preferred method used to reach the individual contact within an organisation.\n\nLETT: Letter\nMAIL: Email\nPHON: Phone\nFAXX: Fax\nCELL: Mobile phone\n", "type": "string", "enum": [ "LETT", "MAIL", "PHON", "FAXX", "CELL" ], "example": "CELL" }, { "description": "PreferredMethod\nPreferred method used to reach the contact.\n" } ] } }, "example": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } }, { "description": "ContactDetails\nSet of elements used to indicate how to contact the party.\n" } ] } }, "required": [ "Id" ], "example": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" }, "Id": { "OrgId": { "Othr": { "Id": 123, "SchmeNm": { "Prtry": "DfspId" } } } }, "CtryOfRes": "BE", "CtctDtls": { "NmPrfx": "Mr", "Nm": "John Doe", "PhneNb": "+123-123-321", "MobNb": "+123-123-321", "FaxNb": "+123-123-321", "EmailAdr": "example@example.com" } } }, { "description": "Party\nAccount owner that owes an amount of money or to whom an amount of money is due.\n" } ] }, "Acct": { "allOf": [ { "title": "CashAccount40", "type": "object", "additionalProperties": false, "description": "Provides the details to identify an account.\n", "properties": { "Id": { "allOf": [ { "title": "AccountIdentification4Choice", "type": "object", "additionalProperties": false, "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", "anyOf": [ { "properties": { "IBAN": { "allOf": [ { "title": "IBAN2007Identifier", "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", "type": "string", "example": "FR1420041010050500013M02606", "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$" }, { "description": "IBAN\nInternational 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.\n" } ] } }, "required": [ "IBAN" ] }, { "properties": { "Othr": { "allOf": [ { "title": "GenericAccountIdentification1", "type": "object", "additionalProperties": false, "description": "GenericAccountIdentification\nUnique and unambiguous identification of an account, as assigned by the account servicer.\n", "properties": { "Id": { "allOf": [ { "title": "Max34Text", "description": "Specifies a character string with a maximum length of 34 characters.\n", "type": "string", "minLength": 1, "maxLength": 34, "example": 1.2345678901234568e+33 }, { "description": "Identification\nIdentification assigned by an institution.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "AccountSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Sets of elements to identify a name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalAccountIdentification1Code", "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": 1111 } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an account, as assigned by the account servicer, using an identification scheme.\n" } ] } }, "required": [ "Othr" ] } ], "example": { "IBAN": "BE71096123456769" } }, { "description": "Identification\nUnique and unambiguous identification for the account between the account owner and the account servicer.\n" } ] }, "Tp": { "allOf": [ { "title": "CashAccountType2Choice", "description": "Specifies the nature, or use of the account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalCashAccountType1Code", "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nAccount type, in a coded form.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nNature or use of the account in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CACC" } }, { "description": "Type\nSpecifies the nature, or use of the account.\n" } ] }, "Ccy": { "allOf": [ { "title": "ActiveOrHistoricCurrencyCode", "type": "string", "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\nNOTE: This has been modified away from the original ISO20022 pattern to enums.\n", "example": "USD", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XTS", "XXX", "YER", "ZAR", "ZMW", "ZWD" ] }, { "description": "Currency\nIdentification of the currency in which the account is held.\nUsage: 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.\n" } ] }, "Nm": { "allOf": [ { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, { "description": "Name\nName 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.\nUsage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.\n" } ] }, "Prxy": { "allOf": [ { "title": "ProxyAccountIdentification1", "description": "Information related to a proxy identification of the account.\n", "type": "object", "additionalProperties": false, "properties": { "Tp": { "allOf": [ { "title": "ProxyAccountType1Choice", "description": "Specifies the type of the proxy account.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalProxyAccountType1Code", "description": "Specifies the external proxy account type code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nProxy account type, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProxy account type, in a proprietary form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "EMAIL" } }, { "description": "Type\nType of the proxy identification.\n" } ] }, "Id": { "allOf": [ { "title": "Max2048Text", "description": "Specifies a character string with a maximum length of 2048 characters.\n", "type": "string", "minLength": 1, "maxLength": 2048, "example": 2048 }, { "description": "Identification\nIdentification used to indicate the account identification under another specified name.\n" } ] } }, "required": [ "Id" ], "example": { "Tp": { "Cd": "IBAN" }, "Id": 123 } }, { "description": "Proxy\nSpecifies an alternate assumed name for the identification of the account.\n" } ] } }, "example": { "Id": { "IBAN": "BE71096123456769" }, "Tp": { "Cd": "CACC" }, "Ccy": "EUR", "Nm": "My account", "Prxy": { "Id": 12345 } } }, { "description": "Account\nUnambiguous identification of the account of a party.\n" } ] }, "Agt": { "allOf": [ { "title": "BranchAndFinancialInstitutionIdentification6", "type": "object", "additionalProperties": false, "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", "properties": { "FinInstnId": { "allOf": [ { "title": "FinancialInstitutionIdentification18", "type": "object", "additionalProperties": false, "description": "Information used to identify a financial institution.\n", "properties": { "BICFI": { "allOf": [ { "title": "BICFIDec2014Identifier", "type": "string", "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", "example": "J5BMVH7D" }, { "description": "BICFI\nCode allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"\n" } ] }, "ClrSysMmbId": { "allOf": [ { "title": "ClearingSystemMemberIdentification2", "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", "type": "object", "additionalProperties": false, "properties": { "ClrSysId": { "allOf": [ { "title": "ClearingSystemIdentification2Choice", "description": "Specifies the clearing system identification.\n", "type": "object", "additionalProperties": false, "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalClearingSystemIdentification1Code", "description": "Specifies the external clearing system identification code.\n", "type": "string", "minLength": 1, "maxLength": 5, "example": 12345 }, { "description": "Code\nClearing system identification code, as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nProprietary identification of the clearing system.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "CHIPS" } }, { "description": "ClearingSystemIdentification\nSpecification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.\n" } ] }, "MmbId": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "MemberIdentification\nIdentification of a member of a clearing system.\n" } ] } }, "required": [ "MmbId" ], "example": { "ClrSysId": { "Cd": "CHQB" }, "MmbId": 123456789 } }, { "description": "ClearingSystemMemberIdentification\nInformation used to identify a member within a clearing system\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "LEI\nLegal entity identifier of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "PostalAddress\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] }, "Othr": { "allOf": [ { "title": "GenericFinancialIdentification1", "type": "object", "additionalProperties": false, "description": "GenericFinancialIdentification\nUnique and unambiguous identification of a person, which is used to refer to a person in a financial context.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a person.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "FinancialIdentificationSchemeName1Choice", "type": "object", "additionalProperties": false, "description": "Specifies the name of the identification scheme.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "title": "ExternalFinancialInstitutionIdentification1Code", "description": "Specifies the external financial institution identification code.", "type": "string", "minLength": 1, "maxLength": 4, "example": 1234 }, { "description": "Code\nName of the identification scheme, in a coded form as published in an external list.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Proprietary\nName of the identification scheme, in a free text form.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "BIC" } }, { "description": "SchemeName\nName of the identification scheme.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] } }, "required": [ "Id" ], "example": { "Id": 123, "SchmeNm": { "Cd": "IBAN" }, "Issr": "BIC" } }, { "description": "Other\nUnique identification of an agent, as assigned by an institution, using an identification scheme.\n" } ] } }, "required": [], "example": { "BICFI": "J5BMVH7D", "ClrSysMmbId": { "ClrSysId": 1234, "MmbId": 123 }, "LEI": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" }, "Othr": { "Id": 123, "SchmeNm": { "Cd": 123, "Prtry": 123 }, "Issr": 123 } } }, { "description": "FinancialInstitutionIdentification\nUnique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.\n" } ] }, "BrnchId": { "allOf": [ { "title": "BranchData3", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific branch of a financial institution.\n", "properties": { "Id": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Identification\nUnique and unambiguous identification of a branch of a financial institution.\n" } ] }, "LEI": { "allOf": [ { "title": "LEIIdentifier", "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", "type": "string", "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", "example": "529900T8BM49AURSDO55" }, { "description": "Legal Entity Identifier\nLegal entity identification for the branch of the financial institution.\n" } ] }, "Nm": { "allOf": [ { "title": "Max140Text", "description": "Specifies a character string with a maximum length of 140 characters.\n", "type": "string", "minLength": 1, "maxLength": 140, "example": 12345 }, { "description": "Name\nName by which an agent is known and which is usually used to identify that agent.\n" } ] }, "PstlAdr": { "allOf": [ { "title": "PostalAddress24", "type": "object", "additionalProperties": false, "description": "Information that locates and identifies a specific address, as defined by postal services.\n", "properties": { "AdrTp": { "title": "AddressType3Choice", "type": "object", "additionalProperties": false, "description": "Choice of formats for the type of address.\n", "anyOf": [ { "properties": { "Cd": { "allOf": [ { "description": "AddressType2Code\nSpecifies the type of address.\nADDR Address\nPBOX PostBox\nHOME Home\nBIZZ Business\nMLTO MailingTo\nDLVY Delivery\n", "enum": [ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ], "type": "string", "example": "ADDR" }, { "description": "Code\nType of address expressed as a code.\n" } ] } }, "required": [ "Cd" ] }, { "properties": { "Prtry": { "allOf": [ { "title": "GenericIdentification30", "type": "object", "additionalProperties": false, "description": "Generic scheme identification for a party.\n", "properties": { "Id": { "allOf": [ { "title": "Exact4AlphaNumericText", "description": "Specifies an alphanumeric string with a length of 4 characters.\n", "type": "string", "pattern": "^[a-zA-Z0-9]{4}$", "example": 1234 }, { "description": "Identification\nProprietary information, often a code, issued by the data source scheme issuer.\n" } ] }, "Issr": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "Issuer\nEntity that assigns the identification.\n" } ] }, "SchmeNm": { "allOf": [ { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, { "description": "SchemeName\nShort textual description of the scheme.\n" } ] } }, "required": [ "Id", "Issr" ], "example": { "Id": 1234, "Issr": "BIC", "SchmeNm": "BICFI" } }, { "description": "Proprietary\nType of address expressed as a proprietary code.\n" } ] } }, "required": [ "Prtry" ] } ], "example": { "Cd": "ADDR" } }, "Dept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "SubDept": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "StrtNm": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "BldgNb": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "BldgNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Flr": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstBx": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "Room": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 }, "PstCd": { "title": "Max16Text", "description": "Specifies a character string with a maximum length of 16 characters.\n", "type": "string", "minLength": 1, "maxLength": 16, "example": 1234567890123456 }, "TwnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "TwnLctnNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "DstrctNm": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "CtrySubDvsn": { "title": "Max35Text", "description": "Specifies a character string with a maximum length of 35 characters.\n", "type": "string", "minLength": 1, "maxLength": 35, "example": 1.234567890123457e+34 }, "Ctry": { "title": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "example": "US", "description": "Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).\n" }, "AdrLine": { "title": "Max70Text", "description": "Specifies a character string with a maximum length of 70 characters.\n", "type": "string", "minLength": 1, "maxLength": 70, "example": 1.2345678901234567e+99 } }, "example": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "StrtNm", "BldgNb": "BldgNb", "BldgNm": "BldgNm", "Flr": "Flr", "PstBx": "PstBx", "Room": "Room", "PstCd": "PstCd", "TwnNm": "TwnNm", "TwnLctnNm": "TwnLctnNm", "DstrctNm": "DstrctNm", "CtrySubDvsn": "CtrySubDvsn", "Ctry": "Ctry", "AdrLine": "AdrLine" } }, { "description": "Postal Address\nInformation that locates and identifies a specific address, as defined by postal services.\n" } ] } }, "example": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } }, { "description": "BranchIdentification\nDefinition: Identifies a specific branch of a financial institution.\nUsage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.\n" } ] } }, "required": [ "FinInstnId" ], "example": { "FinInstnId": { "BICFI": "J5BMVH7D" }, "BrnchId": { "Id": 123, "Nm": "Name", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Department", "SubDept": "Sub department", "StrtNm": "Street name", "BldgNb": "Building number", "PstCd": "Post code", "TwnNm": "Town name", "CtrySubDvsn": "Country subdivision", "Ctry": "Country", "AdrLine": "Address line" } } } }, { "description": "Agent\nFinancial institution servicing an account for a party.\n" } ] } }, "required": [ "Pty" ], "example": { "Pty": { "Id": { "OrgId": { "AnyBIC": { "BICFI": "BICFI" } } }, "CtryOfRes": "FI" }, "Acct": { "Id": { "IBAN": "FI2112345600000785" } }, "Agt": { "FinInstnId": { "BICFI": "BICFI" } } } }, { "description": "UpdatedPartyAndAccountIdentification\nProvides party and/or account identification information.\n" } ] } }, "required": [ "OrgnlId", "Vrfctn" ], "example": { "OrgnlId": 1.2345678901234568e+33, "Vrfctn": true, "OrgnlPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } }, "UpdtdPtyAndAcctId": { "Nm": "John Doe", "PstlAdr": { "AdrTp": "ADDR", "Dept": "Dept", "SubDept": "SubDept", "StrtNm": "1234 Elm St", "BldgNb": 1234, "PstCd": 12345, "TwnNm": "Anytown", "CtrySubDvsn": "CA", "Ctry": "US" }, "Id": { "OrgId": { "AnyBIC": "ABCDUS33", "Othr": { "Id": 123456789, "Issr": "ABA" } } } } } }, "hexBinary": { "title": "hexBinary", "type": "string", "example": 4660, "pattern": "^[A-Za-z0-9-_]+[=]{0,2}$" } }